|
|
@@ -3,8 +3,18 @@ Contributing to CivetWeb
|
|
|
|
|
|
Contributions to CivetWeb are welcome, provided all contributions carry the MIT license.
|
|
|
|
|
|
-- Please first create an issue on GitHub or create a thread on the CivetWeb discussion group. This is required, if the API ([civetweb.h](https://github.com/civetweb/civetweb/blob/master/include/civetweb.h)) is affected.
|
|
|
-- If possible, create a pull request on GitHub. Please take care your modifications pass the continuous integration checks. These checks are performed automatically when you create a pull request, but it may take some hours until all tests are completed. Please provide a description for every pull request.
|
|
|
-- Alternatively, you can post a patch. However, pull requests are preferred.
|
|
|
-- Contributor names are listed in CREDITS.md, unless you explicitly state you don't want your name to be listed there.
|
|
|
+- Please report issues on GitHub. If the issue you want to report is already reported there, add a note
|
|
|
+with your specific details to that issue. In case of doubt, please create a new issue.
|
|
|
+- If you know how to fix the issue, please create a pull request on GitHub. Please take care your modifications pass the continuous integration checks. These checks are performed automatically when you create a pull request, but it may take some hours until all tests are completed. Please provide a description for every pull request.
|
|
|
+- Alternatively, you can post a patch or describe the required modifications in a GitHub issue.
|
|
|
+However, a pull request would be preferred.
|
|
|
+- Contributor names are listed in CREDITS.md, unless you explicitly state you don't want your name to be listed there. This file is occasionally updated, adding new contributors, using author names from git commits and GitHub comments.
|
|
|
+
|
|
|
+
|
|
|
+- In case your modifications
|
|
|
+-- modify or extend the API
|
|
|
+-- affect multi-threading
|
|
|
+-- imply structural changes
|
|
|
+-- have significant influence on maintenance
|
|
|
+please first create an issue on GitHub or create a thread on the CivetWeb discussion group, to discuss the planned changed.
|
|
|
|
bel2125