Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

68 lines (43 loc) · 2.86 KB

Contributing to Codeforces readme stats

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting an issue
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

All Changes Happen Through Pull Requests

Pull requests are the best way to propose changes. We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add some tests.
  3. If you've changed APIs, update the documentation.
  4. Issue that pull request!

Local Development

To run & test codeforces-readme-stats, you need to follow a few simple steps:-

  1. Fork the repository and clone the code to your local machine.
  2. Run npm install in the repository root.
  3. Run the command npm run dev to start the development server at http://localhost:3000.
  4. To run the development server for docs use command mkdocs serve (setup it using command pip install mkdocs mkdocs-material)

Themes Contribution

Codeforces Readme Stats supports custom theming, and you can also contribute new themes!

All you need to do is edit the src/themes.js file and add your theme at the end of the file.

While creating the Pull request to add a new theme don't forget to add a screenshot of how your theme looks, you can also test how it looks using custom URL parameters like title_color, icon_color, bg_color, text_color, border_color

Any contributions you make will be under the MIT Software License

In short, when you submit changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report issues/bugs using GitHub's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Bug Reports

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Share the snapshot, if possible.
  • What actually happens
  • What you expected would happen
  • Notes (possibly including why you think this might be happening or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Feature Request

Great Feature Requests tend to have:

  • A quick idea summary
  • What & why do you want to add the specific feature
  • Additional context like images, links to resources to implement the feature, etc.

License

By contributing, you agree that your contributions will be licensed under its MIT License.