Skip to content

Latest commit

 

History

History
53 lines (30 loc) · 1.99 KB

CONTRIBUTION.md

File metadata and controls

53 lines (30 loc) · 1.99 KB

How to contribute to this project

TwitterBot welcomes contributions from the community.

Code of Conduct

Please go through CodeofConduct.md and make sure your interaction with the project complies with our code of conduct.

Setting up your own fork of this repo.

  • On github interface click on Fork button.
  • Clone your fork of this repo. git clone [email protected]:YOUR_GIT_USERNAME/project_urlname.git
  • Enter the directory cd project_urlname
  • Add upstream repo git remote add upstream https://github.com/author_name/project_urlname

Create a new branch to work on your contribution

Run git checkout -b my_contribution

Make your changes

Edit the files using your preferred editor.

Ensure code coverage report shows 100% coverage, add tests to your PR.

Build the docs locally

Run make docs to build the docs.

Ensure your new changes are documented.

Commit your changes

This project uses conventional git commit messages.

Example: fix(package): update setup.py arguments 🎉 (emojis are fine too)

Push your changes to your fork

Run git push origin my_contribution

Submit a pull request

On github interface, click on Pull Request button.

Wait CI to run and one of the developers will review your PR.

Hacktoberfest Contribution Guidelines:

  1. Be sure you are looking to add something of substance to this project, not just spam PRs. PRs must meet the Hacktoberfest Quality Standards.
  2. Verify that you have read the home page, and Readme.md on GitHub. You understand that this project is to connect maintainers with developers, not a way to get all the swag you can.
  3. Please be available to make changes within 48 hours when requested to do so. If you don't, then your PR may be closed.
  4. Please fix all issues flagged by the bots, including CodeClimate, GH Actions, Netlify, CircleCI or any others as soon as possible, ideally right away.