-
Notifications
You must be signed in to change notification settings - Fork 1
Development Setup & General Process
jschnapper edited this page Oct 30, 2018
·
6 revisions
- Each feature and independent fix should exist on their own branch
- Follow the steps regarding creating issues here
- Since pushes and merges will occur regularly, follow this process to make sure you are up to date when creating a new branch:
git checkout staging
-
git pull
to update your local repository - Then create a branch off your development branch following this naming convention:
[fix or feature]/[feature or fix title]/#[issue number]
. For examplefix/modal_display_error/#107
. This kind of branch is called a "feature branch".
- All of your changes related to that issue should stay on this branch only. If you decide to address another issue, make sure you follow the steps outlined above to create a separate branch in order to prevent changes from another issue getting into different branches
Here is our general workflow for processing features and bugs:
- Assign yourself an issue and/or receive an assignment from the issues
- Make sure your local repository is updated and create a feature branch associated with the issue
- Make your changes and test them locally (commit early and often)
- When you are done making changes, you can push your branch like this
git push origin [feature branch name]
. Example:git push origin fix/modal_display_error/#107
. - You can now open a pull request to merge your branch with
staging
, but don't merge yet! Assign 1-2 developers to review you changes. Follow these steps on making a pull request. In the description for the pr, include references to the issues using "#[issue_num]". - The changes will then go through a final review during the development meeting, after which we will merge into
staging
and deploystaging
to the staging site. - The staging site will then be reviewed during the all-hands meeting
- If minor changes are requested, make the appropriate changes following steps 3 to 5
- If major changes are request, we will go through another week following all the steps above
- We'll merge
staging
intomaster
and deploymaster
to the production site. All done!
Here's a handy "Am I ready to deploy?" checklist:
- Did you test your changes locally?
- Did you test your changes on staging?
- Did you open a pull request for this?
-
Did the CI tests finish successfully?(they don't work right now) - If your change is significant, did you present them at a meeting?
TheDesignExchange / app / wiki
This is the wiki for the DesignExchange app. We will put important info on here.
For everyone
thedesignexchange ⁺
-staging ⁺
Development Guidelines
Review and Release Cycle
Deployment How-to
Keeping Up with the Repo
Google Drive ⁺
Meeting Notes ⁺
For developers
API
⁺ external links open in new tab