Skip to content

Commit fa1a6ea

Browse files
authored
Update contributors guide
This is mostly the same text from the new pull request template.
1 parent 36e410f commit fa1a6ea

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

.github/CONTRIBUTING.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1-
Because of spam, an automated bot will automatically close all pull requests
2-
opened on this repository. If you've found a legitimate bug in the source code,
3-
you can open an issue to report it.
1+
This project is intended to contain high quality implementations of data structures and algorithms. Do not submit code that you just wrote for a class assignment.
42

5-
This project isn't a dumping ground for random bits of C code you've written.
6-
That goes double if you're being instructed to send pull requests as part of a
7-
competition or a school class.
3+
If you are planning to add a new module (data structure or algorithm), you may want to open an issue to discuss your plan with the project maintainer first. This will avoid wasted effort on your part.
4+
5+
If you are planning to submit a pull request, please ensure that your change:
6+
* Is written in the C programming language.
7+
* Conforms to the project's style guidelines.
8+
* Does not duplicate existing code already present.
9+
* Passes all unit test checks (existing code). Run `make check` to confirm.
10+
* Adds unit tests (new code) with at least 95% coverage. Build with `configure –enable-coverage` to confirm.
11+
* Is properly documented using Doxygen comments.
12+
13+
Automated continuous integration checks will fail for many of the above requirements if they are not satisfied.

0 commit comments

Comments
 (0)