Skip to content

Commit e4cefac

Browse files
authored
Create initial contrbuting guides (#2244)
* start creating contrbuting guides Signed-off-by: Evan Baker <[email protected]> * add CLA instructions Signed-off-by: Evan Baker <[email protected]> --------- Signed-off-by: Evan Baker <[email protected]>
1 parent 53d114c commit e4cefac

File tree

4 files changed

+53
-0
lines changed

4 files changed

+53
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Contributing guidelines
2+
Contributers must sign the CLA. The CLA bot will post instructions to new contributors when their first PR is opened as a comment. To agree to the CLA, respond:
3+
4+
> [@microsoft-github-policy-service agree](https://github.com/microsoft/contributorlicenseagreement#accepting)
5+
6+
If you have previously agreed to the CLA but the check is failing/not running, try rerunning with:
7+
8+
> @microsoft-github-policy-service rerun
9+
10+
11+
### Specific guide docs
12+
- [GitHub contributing guidelines](docs/contributing/github.md)
13+
- [Git best-practices guide](docs/contributing/git.md)
14+
- [Go style guidelines](docs/contributing/go.md)

docs/contributing/git.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Git best-practices guide
2+
3+
Write good commit messages.
4+
- https://chris.beams.io/posts/git-commit/
5+
- https://www.gitkraken.com/learn/git/best-practices/git-commit-message
6+
7+
[Rebase, don't merge](https://www.atlassian.com/git/tutorials/rewriting-history/git-rebase).
8+
9+
10+
Configure your fork to rebase from the upstream master branch by default:
11+
```bash
12+
git config branch.master.remote upstream && git config branch.autoSetupRebase always
13+
```

docs/contributing/github.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## GitHub contributing guidelines
2+
### General
3+
- Use a [forking workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow). [(How to fork)](https://help.github.com/articles/fork-a-repo/).
4+
5+
### Pull Requests
6+
Do:
7+
- Scope PRs to the smallest self-contained change possible.
8+
- Open one PR per change (for example: a feature addition and a refactor of related code are separate changes warranting separate PRs).
9+
- Use a descriptive title and description. Provide enough context that anyone familiar with the codebase can understand the purpose of the change and review it.
10+
- Include a link to a related issue if applicable.
11+
- Attach labels.
12+
- Assign reviewers if the automated reviewer assignment is insufficient.
13+
- Open PRs early as a draft and add the `WIP` label to get early feedback.
14+
- Rebase from master when your branch/PR is out of date.
15+
- Fix review feedback in individual commits with descriptive commit messages (and link these commits in the comments).
16+
17+
Do not:
18+
- Link to private issue trackers or internal documents.
19+
- Ask for final reviews unless CI is passing.
20+
- Resolve reviewer comments yourself (allow the reviewer to do so once they are satisfied that their feedback is addressed).
21+
- Close and open a new PR to address git conflicts or feedback (PRs are documentation. One PR per change).

docs/contributing/go.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
### Go style guidelines
2+
Do:
3+
- By default follow the [Uber Go style guide](https://github.com/uber-go/).
4+
- Prefer `zap` for structured logging.
5+
- Prefer `pkg/errors` for error handling.

0 commit comments

Comments
 (0)