-
Notifications
You must be signed in to change notification settings - Fork 1.2k
more documentation around creating preview sites #1403
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fix the if and it looks great
README.md
Outdated
## Datadog Staff | ||
|
||
* Always branch off of master | ||
* Create a branch `slack_handle/your_feature` if you would like to create a preview site and run tests |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i would drop the 'if you would like....' - always create the branch. no ifs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think the 'if' is meant to operate on 'Create'; it operates on 'you would like to create a preview site"
Probably 'Name' is better: "Name your branch slack_handle/your_feature
if you would like to..."
The first item is about creating, and is not optional:
- Create a local branch off of master; never commit directly to master
- Name your branch
slack_handle/your_feature
if you would like to create a preview site and run tests
And so on.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
but i think its a good naming strategy and we should encourage it. It seems to be what most do anyway
README.md
Outdated
|
||
* Always branch off of master | ||
* Create a branch `slack_handle/your_feature` if you would like to create a preview site and run tests | ||
* Never commit directly to master |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems redundant with the first item. Maybe combine them both: "Always branch off of master; never commit directly to master"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes
Just some more context around how things work. This could all be built out much more, but I have been focusing on not dropping any balls on this migration.