-
Notifications
You must be signed in to change notification settings - Fork 24
Contributing
Bloom is an open-source project and we welcome outside contributions. To begin, you should first review our setup instructions for the Backend, Public Site, and Partner's Portal.
Our development tasks are managed through GitHub issues and any development should be tied to an issue. Before creating an issue, check first to see if one already exists. When creating an issue, give it a descriptive title and feel free to include screenshots if relevant.
Pull requests are opened to the dev branch, not to master. When opening a pull request please fill out the entire pull request template which includes tagging the issue your PR is related to, a description of your PR, indicating the type of change, including details for the reviewer about how to test your PR, and a testing checklist.
Every PR should manually update our changelog. Find the relevant section (General, Frontend, Backend, UI Components) and subsection (Added, Changed, Fixed) and add a short description of your change followed by a link to the PR and your name (- Description Here ([#1234](https://github.com/bloom-housing/bloom/pull/1234)) (Your Name)). If it is a breaking change, please include **Breaking Change** and some notes below about how to migrate.
It is not required, but adding the ready for review label onto your PR when it is ready will help surface it to our internal team, as will assigning specific reviewers.
Once the PR has been approved, we squash and merge into dev.