Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

52 lines (40 loc) · 2.05 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to the git-bundle-server project. Your work is extremely appreciated ⭐.

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Prerequisites for running and testing code

Check out the project's README for thorough guidance on how to hit the ground running 💨.

Submitting a pull request

  1. Clone the repository.
  2. Reference the project's README to build, test, and lint.
  3. Create a new branch: git checkout -b <my-branch-name>
  4. Do some awesome work ✨.
  5. Add tests and make sure the tests and linter still pass.
  6. Push your changes and submit a pull request.
  7. Pat yourself on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Write tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Resources