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 discuess the changes you wish to implement 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.
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 馃憤
When making the pull request, please ensure you tick Allow edits by maintainers. More info here
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.
- Clone the repo and cd into it
- Ensure
poetryis installed -pip install poetry - Run
poetry install - Make whatever changes you need
- To text changes run (in project root directory)
poetry run happy