X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=CONTRIBUTING.md;h=791446a0a7b38af4a1b7a897aed3e4dc184ca7ac;hb=d87be963b63b74b9a8052074234d39e7eb75a351;hp=74dd42ecb9788f818b1975435f56196b7a254109;hpb=3447f33dee731225f1951e9ede81a55677242ef2;p=collectd.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 74dd42ec..791446a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Thanks for taking the time to contribute to the [collectd project](https://collectd.org/)! This document tries to give some guidance to -make the process of contributing to *collectd* as pleasant and possible. +make the process of contributing to *collectd* as pleasant as possible. ## Bug reports @@ -11,14 +11,15 @@ Issues](https://github.com/collectd/collectd/issues). Try to answer the following questions: * Which version of *collectd* are you using? -* How can we reproduce the problem you're having? +* Which operating system (distribution) are you using at which version? * What is the expected behavior / output? * What is the actual (observed) behavior / output? +* How can we reproduce the problem you're having? * If *collectd* crashes, try to get a [stack trace](https://collectd.org/wiki/index.php/Core_file). Please monitor your issue for a couple of days and reply to questions. To keep -the project manageable have to do some housekeeping, meaning we will close +the project manageable, we have to do some housekeeping; meaning we will close issues that have become stale. ## Code contributions @@ -34,15 +35,15 @@ the mailing list have a tendency to fall through the cracks. coding style of the code around your changes. * *Documentation:* New config options need to be documented in two places: the manpage (`src/collectd.conf.pod`) and the example config - (`src/collectd.conf.in`). + (`src/collectd.conf.in`). New plugins need to be added to the `README` file. * *Continuous integration:* Once your PR is created, our continuous integration environment will try to build it on a number of platforms. If this reports a failure, please investigate and fix the problem. We will at best do a very casual review for failing PRs. -* *Don't rebase:* Rebasing our branch destroys the review history. If a review +* *Don't rebase:* Rebasing your branch destroys the review history. If a review takes a long time, we may ask you to rebase on a more recent *master*, but please don't do it without being asked. -* *types.db:* One of the most common mistakes done by new contributors is the +* *types.db:* One of the most common mistakes made by new contributors is the addition of (many) new *types* in the file `src/types.db`. The majority of usecases can be met with one of the existing entries. If you plan to add new entries to `src/types.db`, you should talk to us early in the design