Skip to content

Commit

Permalink
Add new pull request template
Browse files Browse the repository at this point in the history
In particular there is no longer a bot that closes pull requests.
  • Loading branch information
fragglet authored Dec 14, 2024
1 parent 8c1158e commit 36e410f
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
DO NOT SUBMIT PULL REQUESTS HERE.
<!--
Thank you for contributing to the project. Please read the following or your pull request may be closed without comment.
Because of spam, an automated bot will automatically close all pull requests
opened on this repository. If you've found a legitimate bug in the source code,
you can open an issue to report it.
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.
This project isn't a dumping ground for random bits of C code you've written.
That goes double if you're being instructed to send pull requests as part of a
competition or a school class.
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.
Before filing your pull request, please ensure that your change:
* Is written in the C programming language.
* Conforms to the project's style guidelines.
* Does not duplicate existing code already present.
* Passes all unit test checks (existing code). Run `make check` to confirm.
* Adds unit tests (new code) with at least 95% coverage. Build with `configure –enable-coverage` to confirm.
* Is properly documented using Doxygen comments.
Automated continuous integration checks will fail for many of the above requirements if they are not satisfied.

0 comments on commit 36e410f

Please sign in to comment.