Building Council has been an absolute pleasure and we couldn't have done it without the feedback and support from you all. We're always looking to make Council better and would love to see community submissions to improve the quality of the codebase.
- Fork this repository
- Clone your fork
- Follow the installation & build steps in the README
- Open a Pull Request (PR) with the [WIP] flag against the development branch and describe the change you are intending to undertake in the PR description.
After confirming the following requirements, please remove the [WIP] tag and submit the PR for review:
- It's properly formatted with Prettier (
yarn format:check) - It passes lint check (
yarn lint) - It builds (
yarn build) - Your changes have sufficient test coverage (e.g regression tests have been added for bug fixes)
Confirm that your PR targets the 'main' branch. Your branch must be prefixed by a description of its function eg. 'fix', 'feature', or 'refactor'.
- All PRs will need to be reviewed by a core maintainer before being squashes and merged.
- Persons qualified to merge and review PRs are likely busy and thus for some PRs it may take several weeks for review, we ask you to remain patient and respectful throughout that process.
- Create a new issue.
- Comment on the issue (if you'd like to be assigned to it) - that way our team can assign the issue to you.
We maintain a polite and respectful development community and one which is welcoming of people from all backgrounds. As such, we invite all those who participate in our community to help us foster a safe and positive experience for everyone. We expect our community members to treat their peers with respect. Harassment of any kind, including racism, hate speech, harmful language, etc. will NOT be tolerated. If your behavior is not in line with those community expectations you will be removed from community discussions and lose any review abilities or other community standings which have been entrusted to you.