-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add contributing.md * remove local config test for user config * Update CONTRIBUTING.md Co-authored-by: Jarryd Tilbrook <jarryd@buildkite.com> * Updated with suggested revisions --------- Co-authored-by: Jarryd Tilbrook <jarryd@buildkite.com>
- Loading branch information
1 parent
44d94d4
commit ea8864b
Showing
3 changed files
with
28 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Contributing | ||
|
||
We welcome contributions from the community to make Buildkite CLI, `bk`, project even better. | ||
|
||
## Getting Started | ||
|
||
To get started with contributing, please follow these steps: | ||
|
||
1. Fork the repository | ||
2. Create a feature branch with a nice name (`git checkout -b cli-new-feature`) for your changes | ||
3. Write your code | ||
* We use `golangci-lint` and would be good to use the same in order to pass a PR merge. You can use `docker-compose -f .buildkite/docker-compose.yaml run lint` for that. | ||
* Make sure the tests are passing by running go test ./... | ||
5. Commit your changes and push them to your forked repository. | ||
7. Submit a pull request with a detailed description of your changes and linked to any relevant issues. | ||
|
||
The team maintaining this codebase will review your PR and start a CI build for it. For security reasons, we don't automatically run CI against forked repos, and a human will review your PR prior to its CI running. | ||
|
||
## Reporting Issues | ||
|
||
If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository. Provide as much detail as possible, including steps to reproduce the issue. | ||
|
||
## Contact | ||
|
||
If we're really dragging our feet on reviewing a PR, please feel free to ping us through GitHub or Slack, or get in touch with [support@buildkite.com](mailto:support@buildkite.com), and they can bug us to get things done :) | ||
|
||
Happy contributing! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,4 @@ | ||
selected_org: buildkite-org | ||
organizations: | ||
buildkite-test: | ||
api_token: test-token-abcd | ||
preferences: | ||
pipelines: | ||
- first-pipeline | ||
api_token: test-token-abcd |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters