Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

27 lines (16 loc) · 1.75 KB

Contribution Guidelines

First of all, thank you so much for taking a deeper look at the project. It does mean a lot.

PRs and issues of all sorts are welcome, here are some guides to help you out.

When contributing to this repository, preferably first discuss the changes you wish to implement and how via GitHub Issues page.

If you're unure you to help, check out the Todo section of the project's README.md.

Following the commit messages specified in emoji-log is greatly appreciated (however not mandatory). You can use my CLI tool for commits if that's easier.

For info on the logical workings of the program refer to HACKING.md

All changes added must pass the CI tests (TBA) provided by the GitHub Actions workflows. If not, further changes must be done in order to make up for a valid pull request / merge request. If you need help because a test isn't passing, please open an issue 👍

We also have a Code of Conduct in place so please make sure to follow the given set of guidelines and thresholds while you interact with the project!

Contributors will receive recognition for their contributions to mankind (I mean this project) in the Contributors section of the README.md. You will also receive a nice title to describle your abilities and might open-source prowess.

Development Info

  1. Clone the repo and cd into it
  2. Ensure poetry is installed - pip install poetry
  3. Run poetry install
  4. Make whatever changes you need
  5. To text changes run (in project root directory) poetry run unfollow