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

Jump to bottom

Update CONTRIBUTING.md #185

Merged
merged 3 commits into from
Sep 25, 2023
Merged

Update CONTRIBUTING.md #185

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f103d9
Update CONTRIBUTING.md
montyly Jul 28, 2023
01c8d9e
Merge branch 'master' into contributing-guidelines
anishnaik Aug 3, 2023
e1dffcf
Merge branch 'master' into contributing-guidelines
anishnaik Sep 25, 2023
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
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,47 @@ If any of these requirements are violated, you should expect your pull request t

Pull request reviewers have a responsibility to uphold these standards. Even if a pull request is compliant with these requirements, a reviewer which identifies an opportunity to document some caveat (such as a `// TODO: ` comment) should request it be added prior to pull request approval.

### Linters

Several linters and security checkers are run on the PRs.

#### Go

To install

- `go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest`

To run

- `go fmt ./...`
- `golangci-lint run --timeout 5m0s`

#### Markdown/Json/Yaml

To install

- `npm install -g prettier`
- `npm install -g markdown-link-check@3.10.3`

To run

- `prettier '**.json' '**/*.md' '**/*.yml' '!(pkg)'`
- `markdown-link-check --config .github/workflows/resources/markdown_link_check.json ./*.md`

To format (overwrite files)

- `prettier '**.json' '**/*.md' '**/*.yml' '!(pkg)' -w`

#### Github action

To install

- `go install github.com/rhysd/actionlint/cmd/actionlint@latest`

To run

- `actionlint`

### Cross-platform considerations

- Ensure file/directory names do not exceed 32 characters in length to minimize filepath length issues on Windows. File/directory names should be shorter than this where possible.
Expand Down