Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

59 lines (38 loc) · 1.51 KB

🌍 Contributing.

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

👶 Getting Started!

Ready to contribute? Here's how to set up brave-chat-server for local development.

  1. Fork the brave-chat-server repo on GitHub.
  2. Clone your fork locally:
git clone [email protected]:your_name_here/brave-chat-server.git

  1. Follow the instructions listed under the Installation with Make section of the readme file to set up your dev environment.

  2. Create a branch for local development:

git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. When you're done making changes, check that your changes pass tox tests, including testing other Python versions with make:
make test-all
  1. Commit your changes and push your branch to GitHub:
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

📙 Pull Request Guidelines.

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

  1. The pull request should include tests, if possible.
  2. The pull request should work for Python 3.9.10. Check and make sure that the tests pass for all supported Python versions.

💡 Tips.

To run a subset of tests:

make test
make lint
make coverage

Thank you for helping us improve!