Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PR and deploy process doc to repo #46

Merged
merged 5 commits into from Mar 23, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 9 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,12 @@
!!!!! STOP AND READ !!!!!

If the dropdown above says "base fork: lord/master", you are submitting your change to ALL USERS OF SLATE, not just your company. This is probably not what you want. Click "base fork" to change it to the right place.
If the dropdown above says "base fork: lord/master", click "base fork" to change it to the bonsaiai.github.io on the dev branch, NOT master.

If you're actually trying to submit a change to upstream Slate, please submit to our dev branch, PRs sent to the master branch are generally rejected.
PR Review Checklist:
[ ] Test search functionality by pressing enter on mobile/desktop
[ ] Test search functionality by clicking search icon on mobile/desktop
[ ] Test filter functionality
[ ] Test mobile header navigation
[ ] Test desktop header navigation
[ ] Test desktop homepage navigation
[ ] Run blc http://localhost:4567/ -ro (runs broken-link-checker on whatever port you're using)
23 changes: 23 additions & 0 deletions PROCESS.md
@@ -0,0 +1,23 @@
**WARNING**: Never touch the `master` branch, this for the deploy script only. Treat the `dev` branch as a psuedo-master branch.

Before you get started: install broken-link-checker via npm with: `npm install broken-link-checker -g`

# Open PR / PR Review Process
Follow this process before you open a PR against the dev branch, and the reviewer of the PR should also follow these steps to verify QA.
1. Merge origin/dev into local WIP branch
2. Test search functionality by pressing enter on mobile/desktop
3. Test search functionality by clicking search icon on mobile/desktop
4. Test filter functionality
5. Test mobile header navigation
6. Test desktop header navigation
7. Test desktop homepage navigation
8. Run blc http://localhost:4567/ -ro (runs broken-link-checker on whatever port you're using)

# Deploy Process
Follow this process to deploy the dev branch changes to the master branch (and therefore the public website).
1. Change to dev branch (git checkout dev)
2. Pull latest changes from remote dev branch into your local dev branch (git pull)
3. cd to the base folder of slate
4. ./deploy.sh
5. Make sure there were no errors during the deploy and only files you were expecting to change got changed
6. Verify changes were made at docs.bons.ai