Skip to content

Commit

Permalink
docs: update CONTRIBUTING.md (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
Serpentiel authored Sep 5, 2022
1 parent bf58002 commit 6caa763
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
First off, thanks for taking the time to contribute! ❤️

<!-- markdownlint-disable-next-line -->

All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways
to help and details about how this project handles them. Please make sure to read the relevant section before making
your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The
Expand Down Expand Up @@ -159,10 +160,10 @@ Once the bug report is filed:
- The project team will check the issue and label and/or relabel it accordingly
- A team member will try to reproduce the issue with your provided steps
- If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps
and label the issue as `needs repro`—bugs with the `needs repro` label will not be addressed until they are
reproduced
and label the issue as `needs repro`—bugs with the `needs repro` label will not be addressed until they are
reproduced
- If the team is able to reproduce the issue, it will be labeled as `needs fix`, as well as possibly other labels,
and the issue will be left to be [implemented by someone](#your-first-code-contribution)
and the issue will be left to be [implemented by someone](#your-first-code-contribution)

### Suggesting Enhancements

Expand Down Expand Up @@ -200,31 +201,42 @@ Enhancement suggestions are tracked as [GitHub Issues](https://github.com/Serpen

### Your First Code Contribution

<!-- TODO -->
Please, make sure to test everything locally before creating a PR. When creating a PR, please fill the provided
template.

### Improving the Documentation

<!-- TODO -->
You are very welcome to help us to improve the documentation. Please, make sure to check your grammar twice before
submitting the improvement, and try to figure out whether or not the improvement that you are trying to add is already
documented.

<!-- markdownlint-disable -->
<p align="right"><a href="#top">(back to top)</a></p>
<!-- markdownlint-restore -->

## Styleguides

<!-- TODO -->
This project does not possess any specific styleguides. Please, make sure to follow general best practices used in Go
community.

You can use the following resources for the reference:

- [Uber Go Style Guide](https://github.com/uber-go/guide/blob/master/style.md)
- [Effective Go](https://go.dev/doc/effective_go)

### Commit Messages

<!-- TODO -->
This project adheres to the [Conventional Commits](https://conventionalcommits.org/en/v1.0.0/) specification.
Please, make sure that your commit messages follow that specification.

<!-- markdownlint-disable -->
<p align="right"><a href="#top">(back to top)</a></p>
<!-- markdownlint-restore -->

## Join the Project Team

<!-- TODO -->
You will be offered to join the project team if and when your contributions to the project are deemed sufficiently
frequent and good by the members of the existing team.

<!-- markdownlint-disable -->
<p align="right"><a href="#top">(back to top)</a></p>
Expand Down

0 comments on commit 6caa763

Please sign in to comment.