Skip to content

Commit 36e410f

Browse files
authored
Add new pull request template
In particular there is no longer a bot that closes pull requests.
1 parent 8c1158e commit 36e410f

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

.github/pull_request_template.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1-
DO NOT SUBMIT PULL REQUESTS HERE.
1+
<!--
2+
Thank you for contributing to the project. Please read the following or your pull request may be closed without comment.
23
3-
Because of spam, an automated bot will automatically close all pull requests
4-
opened on this repository. If you've found a legitimate bug in the source code,
5-
you can open an issue to report it.
4+
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.
65
7-
This project isn't a dumping ground for random bits of C code you've written.
8-
That goes double if you're being instructed to send pull requests as part of a
9-
competition or a school class.
6+
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.
7+
8+
Before filing your pull request, please ensure that your change:
9+
* Is written in the C programming language.
10+
* Conforms to the project's style guidelines.
11+
* Does not duplicate existing code already present.
12+
* Passes all unit test checks (existing code). Run `make check` to confirm.
13+
* Adds unit tests (new code) with at least 95% coverage. Build with `configure –enable-coverage` to confirm.
14+
* Is properly documented using Doxygen comments.
15+
16+
Automated continuous integration checks will fail for many of the above requirements if they are not satisfied.
17+

0 commit comments

Comments
 (0)