Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

29 lines (20 loc) · 1.44 KB

Contributing to beatsaver-api-wrapper

Thank you for your interest in contributing to beatsaver-api-wrapper! We appreciate your time and effort in helping make this project better.

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine. 
    git clone https://github.com/your-username/your-project.git
  3. Install the dependencies: npm install.
  4. Run all tests to ensure the project is properly configured on your machine: npm test.
  5. Create a new branch: git checkout -b your-branch-name
  6. Make your changes, add tests, and make sure all the tests pass.
  7. Push your changes to your fork and submit a pull request.
  8. Wait for your pull request to be reviewed and merged.

Issue Reporting

If you find any bugs or issues, please report them on the issue tracker with a clear and descriptive title. Provide as much information as possible to help us understand and reproduce the issue.

Feature Requests

If you have a feature request, please open an issue on the issue tracker with a clear title and description. We welcome your ideas and suggestions!

License

By contributing to this project, you agree that your contributions will be licensed under the project's license.