vbatts/go-omaha
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

CONTRIBUTING: update the docs

Browse source 
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
This commit is contained in:
Vincent Batts 2020-09-24 14:54:43 -04:00
parent b0ceef0566
commit f0ff244d87
1 changed files with 3 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
CONTRIBUTING.md
View file

@ -1,7 +1,7 @@
# How to Contribute # How to Contribute
CoreOS projects are [Apache 2.0 licensed](LICENSE) and accept contributions via This project is [Apache 2.0 licensed](LICENSE) and accept contributions via
GitHub pull requests. This document outlines some of the conventions on GitHub-like pull requests. This document outlines some of the conventions on
development workflow, commit message formatting, contact points and other development workflow, commit message formatting, contact points and other
resources to make it easier to get your contribution accepted. resources to make it easier to get your contribution accepted.
@ -12,18 +12,9 @@ Origin (DCO). This document was created by the Linux Kernel community and is a
simple statement that you, as a contributor, have the legal right to make the simple statement that you, as a contributor, have the legal right to make the
contribution. See the [DCO](DCO) file for details. contribution. See the [DCO](DCO) file for details.
# Email and Chat
The project currently uses the general CoreOS email list and IRC channel:
- Email: [coreos-dev](https://groups.google.com/forum/#!forum/coreos-dev)
- IRC: #[coreos](irc://irc.freenode.org:6667/#coreos) IRC channel on freenode.org
Please avoid emailing maintainers found in the MAINTAINERS file directly. They
are very busy and read the mailing lists.
## Getting Started ## Getting Started
- Fork the repository on GitHub - Fork the repository
- Read the [README](README.md) for build and test instructions - Read the [README](README.md) for build and test instructions
- Play with the project, submit bugs, submit patches! - Play with the project, submit bugs, submit patches!
@ -40,12 +31,6 @@ This is a rough outline of what a contributor's workflow looks like:
Thanks for your contributions! Thanks for your contributions!
### Coding Style
CoreOS projects written in Go follow a set of style guidelines that we've documented
[here](https://github.com/coreos/docs/tree/master/golang). Please follow them when
working on your contributions.
### Format of the Commit Message ### Format of the Commit Message
We follow a rough convention for commit messages that is designed to answer two We follow a rough convention for commit messages that is designed to answer two