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

chore: update contributing.md #10

Merged
merged 1 commit into from
Mar 18, 2022
Merged

chore: update contributing.md #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
60 changes: 4 additions & 56 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,15 @@
# 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 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
- [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
Expand Down Expand Up @@ -64,24 +50,6 @@ cd $HOME/go-vela/vela-email

- 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:<linter(s)> // <short reason>
```

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/).

- Build the repository code:

```bash
Expand Down Expand Up @@ -117,26 +85,6 @@ make clean
git push fork main
```

- 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](https://go-vela.github.io/docs/community/contributing_guidelines/#development-workflow) when opening a pull request

Thank you for your contribution!