Instructions for contributing to project
contributions to the repository is categorised as any one of the following
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
If you are a first-timer, please take a look at - my Starter's Guide to Open Source Software
Please make contributions to the repo via Issues and Pull Requests (PRs).
- Search for existing Issues and PRs before creating your own
- Please refer to my Open Source Software guide for more information and steps on the Contributions steps
Issues are categorised as any one of the following
- Requesting a new feature
- Discuss Potential Changes before you create/PR is created
PRs to our libraries are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:
- Only fix/add the functionality in question OR address wide-spread whitespace/style issues, not both.
- Add unit or integration tests for fixed or changed functionality (if a test suite already exists).
- Address a single concern in the least number of changed lines as possible.
- Include documentation in the repo
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
To summarise : follow the "fork-and-pull" Git workflow
- Fork the repository to your own Github account
- Clone the project to your machine
- Create a branch locally with a succinct but descriptive name
- Commit changes to the branch
- Following any formatting and testing guidelines specific to this repo
- Push changes to your fork
- Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
- Please refer to my contacts in the README and feel free to message me if you have any questions!