First, thank you for taking the time to contribute to failover project! 👍
If you have a question, please raise an issue under Need a help section in issues.
Reporting an issue or bug is a great way to contribute. The more details you can give the better (e.g. screenshots with the console open) However, before reporting a bug, please check on the existing issues.
Your feedback and the conversations that result from it provide a continuous flow of ideas. However, before creating a ticket, please take the time to initiate a discussion first.
Once you're ready, create an issue on GitHub.
Working on your first Pull Request? You can learn how from this free series, [How to Contribute to an Open Source Project on GitHub] (https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
- Provide a proper description on the pull request.
- Link your pull request to issue if you are solving one.
- Your code must have a proper test.
- Please provide the documentation wherever needed.
- Please update the ADR for documenting your architectural decisions.
- Use the recommender coding styles.
A good review will always help us to improve the quality of our deliverables. Reviews are mainly for a feedback which will help the developers to get a different perception. To have an effective review, please raise a PR with small amount of changes. If you have large amount of changes, the review will be more painful and less effective.