Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 1.17 KB
Raw

Contributing

Thank you for considering contributing to this project.

These guidelines describe how you can help most effectively.

Report Bugs

Please report bugs by opening a new issue on Github.

If you are reporting a bug, please include the following information:

  • Description of the error/error message
  • If applicable: Desired output
  • Version of the package
  • Detailed steps/MWE to reproduce the bug

Fix Bugs

Any open issue that is tagged with "bug" is open to whoever wants to fix it.

Implementing New Features

You are welcome to implement new features and improve existing ones.

How to Submit Your Work

Please follow these steps to create a pull request on GitHub.

  1. Fork the beets repository and clone it to create a workspace.
  2. Make your changes.
  3. Add an example to the main document (review_response.tex) that shows the usage of the new feature and how it will look in the compiled PDF.
  4. Add a changelog entry to CHANGELOG.md near the top of the document. If you are fixing a bug, please also mention the corresponding issue number.
  5. Add documentation to the README.md file.