stv0g/Criterion
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Refactored CONTRIBUTING.md out of README.md

Browse source
This commit is contained in:
Snaipe 2015-09-09 02:30:48 +02:00
parent 5e4c9beaa8
commit 788803d0dd
2 changed files with 42 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,42 @@
# Contributing
Contributions are welcomed, but must follow a simple set of rules in order to
be merged.
**Please follow these conventions if you want your pull request(s) accepted.**
## General
* Use 4 (four) spaces for indentation.
* No trailing whitespaces.
* 80 chars column limit.
* No trash files. Trash files are by-products of the compilation process, or
generated files that does not need to be under version control.
* Pull requests must compile and work properly.
* Pull requests must pass all tests.
* Pull requests must be mergeable automatically.
* Number of commits in a pull request should be kept to one commit and all
additional commits must be squashed.
* You may have more than one commit in a pull request if the commits are
separate changes, otherwise squash them.
## Translations
* You can contribute new translation files for output messages, on the
condition that you are fluent with the language itself.
* Each correction on existing translations must be followed by a
rationale ("why would the translation be better if the change is applied?")
## Roadmap
.
|- .cmake/: CMake modules
|- dependencies/: dependencies for building libcriterion
|- doc/: Sphinx documentation files
|- include/criterion/: Public API
|- src/: Sources for libcriterion
| `- log/: Output providers, all the output logic in general
|- po/: Translation files, i18n stuff
|- test/: Unit tests for libcriterion
`- samples/: Sample files
`- tests/: Internal regression tests

28
README.md
View file

@ -61,34 +61,6 @@ Sample tests can be found in the [sample directory][samples].
* [Tests with signals][sample-signal]
* [Using report hooks][sample-report]
## Contributing
Contributions are welcomed, but must follow a simple set of rules in order to
be merged.
**Please follow these conventions if you want your pull request(s) accepted.**
### General
* Use 4 (four) spaces for indentation.
* No trailing whitespaces.
* 80 chars column limit.
* No trash files. Trash files are by-products of the compilation process, or
generated files that does not need to be under version control.
* Pull requests must compile and work properly.
* Pull requests must be mergeable automatically.
* Number of commits in a pull request should be kept to one commit and all
additional commits must be squashed.
* You may have more than one commit in a pull request if the commits are
separate changes, otherwise squash them.
### Translations
* You can contribute new translation files for output messages, on the
condition that you are fluent with the language itself.
* Each correction on existing translations must be followed by a
rationale ("why would the translation be better if the change is applied?")
## F.A.Q.
**Q. What's wrong with other C test frameworks?**