From cae42c3ff482fab33d8962a10b6a6f9b965a031e Mon Sep 17 00:00:00 2001 From: Kayla McKay Date: Thu, 10 Feb 2022 15:05:54 -0600 Subject: [PATCH 1/3] cleaning contributing doc --- .github/CONTRIBUTING.md | 42 +++-------------------------------------- 1 file changed, 3 insertions(+), 39 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d146c46af..d1a544124 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,8 +1,7 @@ # Contributing -We'd love to accept your contributions to this project! +### We'd love to accept your contributions to this project! If you are a first time contributor, please review our [Contributing Guidelines]() before proceeding. -There are just a few guidelines you need to follow. ## Bugs @@ -62,23 +61,7 @@ cd $HOME/go-vela/server ``` * Write your code and tests to implement the changes you desire. - * Please be sure to [follow our commit rules](https://chris.beams.io/posts/git-commit/#seven-rules) - * Please address linter warnings appropriately. If you are intentionally violating a rule that triggers a linter, please annotate the respective code with `nolint` declarations [[docs](https://golangci-lint.run/usage/false-positives/)]. we are using the following format for `nolint` declarations: - - ```go - // nolint: // - ``` - - Example: - - ```go - // nolint:gocyclo // legacy function is complex, needs simplification - func superComplexFunction() error { - // .. - } - ``` - - Check the [documentation for more examples](https://golangci-lint.run/usage/false-positives/). + * Be sure to follow our [style guide]() * Run the repository code (ensures your changes perform as you desire): @@ -108,25 +91,6 @@ make clean git push fork master ``` -* Open a pull request! - * For the title of the pull request, please use the following format for the title: - - ```text - feat(wobble): add hat wobble - ^--^^------^ ^------------^ - | | | - | | +---> Summary in present tense. - | +---> Scope: a noun describing a section of the codebase (optional) - +---> Type: chore, docs, feat, fix, refactor, or test. - ``` - - * feat: adds a new feature (equivalent to a MINOR in Semantic Versioning) - * fix: fixes a bug (equivalent to a PATCH in Semantic Versioning) - * docs: changes to the documentation - * refactor: refactors production code, eg. renaming a variable; doesn't change public API - * test: adds missing tests, refactors tests; no production code change - * chore: updates something without impacting the user (ex: bump a dependency in package.json or go.mod); no production code change - - If a code change introduces a breaking change, place ! suffix after type, ie. feat(change)!: adds breaking change. correlates with MAJOR in semantic versioning. +* Make sure to follow our [PR process]() when opening a pull request Thank you for your contribution! From eb0a67dee1ce29a08bf433fad0dcec605c6111ef Mon Sep 17 00:00:00 2001 From: Kayla McKay Date: Mon, 7 Mar 2022 09:33:08 -0600 Subject: [PATCH 2/3] add links --- .github/CONTRIBUTING.md | 25 +++++-------------------- 1 file changed, 5 insertions(+), 20 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d1a544124..f9c45489d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,28 +1,14 @@ # Contributing -### We'd love to accept your contributions to this project! If you are a first time contributor, please review our [Contributing Guidelines]() before proceeding. - - -## Bugs - -Bug reports should be opened up as [issues](https://help.github.com/en/github/managing-your-work-on-github/about-issues) on the [go-vela/community](https://github.com/go-vela/community) repository! - -## Feature Requests - -Feature Requests should be opened up as [issues](https://help.github.com/en/github/managing-your-work-on-github/about-issues) on the [go-vela/community](https://github.com/go-vela/community) repository! - -## Pull Requests - -**NOTE: We recommend you start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on.** - -We are always open to new PRs! You can follow the below guide for learning how you can contribute to the project! - ## Getting Started +We'd love to accept your contributions to this project! If you are a first time contributor, please review our [Contributing Guidelines](https://go-vela.github.io/docs/community/contributing_guidelines/) before proceeding. + ### Prerequisites -* [Review the commit guide we follow](https://chris.beams.io/posts/git-commit/#seven-rules) - ensure your commits follow our standards * [Review the local development docs](../DOCS.md) - ensures you have the Vela application stack running locally +* [Review the commit guide we follow](https://chris.beams.io/posts/git-commit/#seven-rules) - ensure your commits follow our standards +* Review our [style guide](https://go-vela.github.io/docs/community/contributing_guidelines/#style-guide) to ensure your code is clean and consistent. ### Setup @@ -61,7 +47,6 @@ cd $HOME/go-vela/server ``` * Write your code and tests to implement the changes you desire. - * Be sure to follow our [style guide]() * Run the repository code (ensures your changes perform as you desire): @@ -91,6 +76,6 @@ make clean git push fork master ``` -* Make sure to follow our [PR process]() when opening a pull request +* Make sure to follow our [PR process](https://go-vela.github.io/docs/community/contributing_guidelines/#development-workflow) when opening a pull request Thank you for your contribution! From bbbcda2ae6cd715a7b9dd13893f3cbfc1e51b28b Mon Sep 17 00:00:00 2001 From: Kayla McKay <39921134+kaymckay@users.noreply.github.com> Date: Mon, 7 Mar 2022 19:07:29 -0600 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f9c45489d..65e1e66a9 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -8,7 +8,7 @@ We'd love to accept your contributions to this project! If you are a first time * [Review the local development docs](../DOCS.md) - ensures you have the Vela application stack running locally * [Review the commit guide we follow](https://chris.beams.io/posts/git-commit/#seven-rules) - ensure your commits follow our standards -* Review our [style guide](https://go-vela.github.io/docs/community/contributing_guidelines/#style-guide) to ensure your code is clean and consistent. +* [Review our style guide](https://go-vela.github.io/docs/community/contributing_guidelines/#style-guide) to ensure your code is clean and consistent. ### Setup