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.

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

docs: update contributing.md with outline for contributing #80

Merged
merged 1 commit into from
Apr 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 39 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,39 @@
## Contributing
## Contributing

We welcome contributions to the project!

### Getting Started
After pulling the repository, you can get started by running the following command to install the necessary dependencies and build `grant` from source
```bash
make
```

After building the project, you can run the following command to run the newly built binary
```bash
./snapshot/<os>-build_<>os_<arch>/grant
```

Keep in mind the build artifacts are placed in the `snapshot` directory and built for each supported platform so choose the appropriate binary for your platform.

If you just want to run the project with any local changes you have made, you can run the following command:
```bash
go run cmd/grant/main.go
```

### Testing
You can run the tests for the project by running the following command:
```bash
make test
```

### Linting
You can run the linter for the project by running the following command:
```bash
make static-analysis
```

### Making a PR
Just fork the repository, make your changes on a branch, and submit a PR. We will review your changes and merge them if they are good to go.

When making a PR, please make sure to include a description of the changes you have made and the reasoning behind them.
If you are adding a new feature, please include tests for the new feature. If you are fixing a bug, please include a test that reproduces the bug and ensure that the test passes after your changes.
2 changes: 1 addition & 1 deletion Taskfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ tasks:
sh: "go list ./... | grep -v {{ .OWNER }}/{{ .PROJECT }}/test | tr '\n' ' '"

# unit test coverage threshold (in % coverage)
COVERAGE_THRESHOLD: 10
COVERAGE_THRESHOLD: 8
cmds:
- cmd: "mkdir -p {{ .TMP_DIR }}"
silent: true
Expand Down
Loading