47 lines
1.6 KiB
Markdown
47 lines
1.6 KiB
Markdown
# Contributing
|
|
|
|
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
|
|
|
|
The following is a set of guidelines for contributing to the Jenkins Operator. These are mostly guidelines, not rules.
|
|
Use your best judgment, and feel free to propose changes to this document in a pull request.
|
|
|
|
In this project we appreciate any kind of contributions: code, documentation, design, etc.
|
|
Any contribution counts, and the size does not matter!
|
|
|
|
## Newcomers
|
|
|
|
If you are a newcomer contributor and have any questions, please do not hesitate to ask in the `#jenkins-operator` [Slack](https://virtuslab-oss.slack.com) Channel.
|
|
|
|
#### Table Of Contents
|
|
|
|
[Code of Conduct](#code-of-conduct)
|
|
|
|
## Code of Conduct
|
|
|
|
This project and everyone participating in it is governed by the [Atom Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
|
|
|
|
## Commit Messages
|
|
|
|
All commit messages should follow
|
|
[these best practices](https://chris.beams.io/posts/git-commit/), specifically:
|
|
|
|
- Start with a subject line
|
|
- Contain a body that explains _why_ you're making the change you're making
|
|
- Reference an issue number one exists, closing it if applicable (with text such
|
|
as
|
|
["Fixes #245" or "Closes #111"](https://help.github.com/articles/closing-issues-using-keywords/))
|
|
|
|
Not sure what to put? Try to Include:
|
|
|
|
- What is the problem being solved?
|
|
- Why is this the best approach?
|
|
- What other approaches did you consider?
|
|
- What side effects will this approach have?
|
|
- What future work remains to be done?
|
|
|
|
## Coding standards
|
|
|
|
### Go
|
|
|
|
- [Go code review comments](https://github.com/golang/go/wiki/CodeReviewComments)
|