When contributing to this repository, please first discuss the change you wish to make via an issue.
Please note we have a code of conduct, please follow it in all your interactions with the project.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Please mention the issue in your PR description.
- Expect to be taken seriously, if there are some feedbacks, feel free to discuss about it, your opinion can be better than mine.
A library is easier to use, and easier for contributors to work on if it has a consistent, unified style, approach, and layout.
We are using pre-commit to lint before each commit, I would recommend you to use it.
pre-commit installEvery feature or bug should come with an associate test to keep the coverage as high as possible.
We are maintaining 2 documentations:
- README.md which contains everything you need to know to start working with the module.
- go-feature-flag website which is the full detail website containing the documentation.
If your contribution has impact on the documentation, please check both version. You can check how to work on the documentation here.
For the documentation website we are using Docusaurus 2.
Everything is available in the website/docs directory.
Your can start locally the website.
- Open a terminal and go to the root project of this repository.
- Launch the command bellow, it will install the dependencies and run the local server for the documentation.
make watch-doc- You can now access to the documentation directly in your browser: http://localhost:3000/.
Sonarcloud is used in the project, it will comment your PR to give you feedback on your code.
We have a list of steps on each PR.
The CI is running:
- Tests
- Coverage
- Code quality
With this CI you will have feedbacks on your PR after opening your PR. Please review it if it fails.