From 9d63fdf574788d899c6d337e10950e215a47a9d0 Mon Sep 17 00:00:00 2001 From: Kayla McKay Date: Wed, 16 Mar 2022 11:00:26 -0600 Subject: [PATCH] updating contributing --- .github/CONTRIBUTING.md | 28 +++++++--------------------- 1 file changed, 7 insertions(+), 21 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 54d7458..2ed5fd3 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,31 +1,16 @@ # Contributing -We'd love to accept your contributions to this project! There are just a few guidelines you need to follow. - -## 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 GoLang package structure we use](https://github.com/golang-standards/project-layout) - ensure code is organized to our standards * [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. * [Docker](https://docs.docker.com/install/) - building block for local development * [Docker Compose](https://docs.docker.com/compose/install/) - start up local development * [Verdaccio](https://verdaccio.org/) - start up npm registry -* [Golang](https://golang.org/dl/) - for source code and [dependency management](https://github.com/golang/go/wiki/Modules) * [Make](https://www.gnu.org/software/make/) - start up local development ### Setup @@ -94,8 +79,7 @@ cd $HOME/go-vela/vela-npm make user ``` -* Write your code - - Please be sure to [follow our commit rules](https://chris.beams.io/posts/git-commit/#seven-rules) +* Write your code and tests to implement the changes you desire. * Test your code against the provided example: @@ -118,7 +102,9 @@ make clean git push fork main ``` -* Open a pull request. Thank you for your contribution! +* 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! ### Testing A Different Project