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.

Sign up for GitHub

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

Update CONTRIBUTING.md to include make fmt command #3642

Merged
merged 1 commit into from
Oct 14, 2020
Merged

Update CONTRIBUTING.md to include make fmt command #3642

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,15 @@ Examples:
- [Make sync activity retry multiple times before fetch history from remote](https://github.com/uber/cadence/pull/1379)
- [Enable archival config per domain](https://github.com/uber/cadence/pull/1351)

#### Licence headers
#### Code Format and Licence headers checking

This project is Open Source Software, and requires a header at the beginning of
The project has strict rule about Golang format. You have to run
```bash
make fmt
```
to re-format your code. Otherwise the CI(buildkite) test will fail.

Also, this project is Open Source Software, and requires a header at the beginning of
all new source files you are adding. To verify that all files contain the header execute:

```bash
Expand Down