diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b0c72ac --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing to Arete + +Welcome! We're excited that you're interested in contributing. + +Below you will find some basic steps required to be able to contribute to the project. If you have any questions about this process or any other aspect of contributing to a Yipee open source project, please open an [issue](https://github.com/yipeeio/arete/issues) and we'll get your questions answered as quickly as we can. + +Pull Requests are always welcome, however they will only be accepted if they provide a reasonable test coverage. + +## Workflow + +Arete follows a standard GitHub pull request workflow. If you're unfamiliar with this workflow, read the very helpful [Understanding the GitHub flow](https://guides.github.com/introduction/flow/) guide from GitHub. + +## Getting started + +- Fork the repository on GitHub +- Read the README.md for build instructions + +## Contribution Licensing + +Since `Arete` is distributed under the terms of the [Apache Version 2 license](LICENSE), contributions that you make are licensed under the same terms. In order for us to be able to accept your contributions, we will need explicit confirmation from you that you are able and willing to provide them under these terms, and the mechanism we use to do this is called a Developer's Certificate of Origin [DCO](DCO.md). This is very similar to the process used by the Linux(R) kernel, Samba, and many other major open source projects. + +To participate under these terms, all that you must do is include a line like the following as the last line of the commit message for *each commit* in your contribution: + + `Signed-Off-By: John Q. Developer ` + + The simplest way to accomplish this is to add `-s` or `--signoff` to your `git commit` command. + + You must use your real name (sorry, no pseudonyms, and no anonymous contributions). + + +Additional information on DCOs located at https://github.com/probot/dco#how-it-works + +## Reporting bugs and creating issues + +Reporting bugs is one of the best ways to contribute. However, a good bug report has some very specific qualities, so please read over our short document on [reporting bugs](reporting_bugs.md) before submitting a bug report. This document might contain links to known issues, another good reason to take a look there before reporting a bug. + +Thanks for contributing! + diff --git a/DCO.md b/DCO.md new file mode 100644 index 0000000..b147662 --- /dev/null +++ b/DCO.md @@ -0,0 +1,40 @@ +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. + +--- +Original text of the [DCO](https://developercertificate.org/) diff --git a/reporting_bugs.md b/reporting_bugs.md new file mode 100644 index 0000000..95c697a --- /dev/null +++ b/reporting_bugs.md @@ -0,0 +1,22 @@ +# Reporting bugs + +If any part of the arete project has bugs or documentation mistakes, please let us know by [opening an issue](https://github.com/yipeeio/arete/issues). We treat bugs and mistakes very seriously and believe no issue is too small. Before creating a bug report, please check that an issue reporting the same problem does not already exist. + +To make the bug report accurate and easy to understand, please try to create bug reports that are: + +- Specific. Include as much details as possible: which version, what environment, what configuration, logs, etc. + +- Reproducible. Include the steps to reproduce the problem. We understand some issues might be hard to reproduce, please includes the steps that might lead to the problem. If possible, please attach the rulesets to the bug report. Note, without the rulesets (or sample ones that illustrate the problem) it will be difficult to reproduce. + +- Isolated. Please try to isolate and reproduce the bug with minimum dependencies. It would significantly slow down the speed to fix a bug if too many dependencies are involved in a bug report. Debugging external systems that rely on arete is out of scope, but we are happy to provide guidance in the right direction or help with using arete itself. + +- Unique. Do not duplicate existing bug reports. + +- Scoped. One bug per report. Do not follow up with another bug inside one report. + +It may be worthwhile to read [Elika Etemad’s article on filing good bug reports](http://fantasai.inkedblade.net/style/talks/filing-good-bugs) before creating a bug report. + +We might ask for further information to locate a bug. A duplicated bug report will be closed. + +--- +Majority of the content comes from the [etcd project](https://github.com/etcd-io/etcd/blob/master/Documentation/reporting_bugs.md)