Skip to content

Commit 6a9f56b

Browse files
authored
Update README.md (DataDog#23323)
Adds the "why" to encourage internal contributors to follow branch naming convention.
1 parent 759984a commit 6a9f56b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ For more information on contributing, see the [contribution guidelines][18].
1717
### Datadog Staff
1818

1919
- Always branch off of master; never commit directly to master.
20-
- Name your branch `<SLACK_HANDLE>/<FEATURE_NAME>`.
20+
- Name your branch `<SLACK_HANDLE>/<FEATURE_NAME>`. If you don’t use this convention, the Gitlab pipeline won’t run and you won’t get a branch preview. Getting a branch preview makes it easier for us to check for any issues with your PR, such as broken links.
2121
- Consult our [contributing guidelines][8].
2222
- When you're ready to commit, create a new pull request to master from your branch.
2323
- Use GitHub's [draft pull request][15] feature and appropriate labels such as "Do Not Merge" or "Work in Progress" until your PR is ready to be merged and live on production.

0 commit comments

Comments
 (0)