Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

76 lines (47 loc) · 2.85 KB

Contributing

Contributions to Smash Charts are welcome and highly appreciated. I value any feedback, input, or bug reports you might have. Even the smallest contribution counts, and I will always give proper credit and acknowledgement to your contributions.

Types of Contributions

Report Bugs

If you are reporting a bug, please open an issue and include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Write Documentation

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

I am open to ideas and recommendations for enhancements to Smash Charts.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.

Fix Bugs

Look through the GitHub issues for bugs, which will be tagged as bug.

  • Anything tagged with help wanted is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features, which will be tagged with enhancement.

  • Anything tagged with help wanted is open to whoever wants to implement it.

Setting Up for Local Development

Ready to contribute? Here's how to set up The Super Smash Dashboard for local development.

  1. Fork the Smash Charts repository on GitHub.

  2. Clone your fork to download a copy of Smash Charts locally.

  3. Use git (or similar) to create a branch for local development and make your changes:

    git switch -c name-of-your-bugfix-or-feature

  4. When you're done making changes, check that your changes conform to any code formatting requirements and pass any tests.

  5. Commit your changes and open a pull request.

Contributor Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include additional tests if appropriate.
  2. If the pull request adds functionality, the docs should be updated.
  3. The pull request should work for all currently supported operating systems and versions of Python.

Code of Conduct

Please note that Smash Charts is released with a Code of Conduct. By contributing to this project you agree to abide by its terms.

Attribution

These contribution guidelines were adapted from the Cookiecutter Repository.