summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorPierre Joye <pierre.php@gmail.com>2021-08-24 13:33:30 +0700
committerPierre Joye <pierre.php@gmail.com>2021-08-24 13:33:30 +0700
commitcbb07f6515577980cc10187c91134558a85e463e (patch)
tree7167c32fe01164830b488837c4ad7393193e02fd /CONTRIBUTING.md
parent0eb33b8d3a5d0e55950fae677597bc2b56d07da7 (diff)
downloadlibgd-cbb07f6515577980cc10187c91134558a85e463e.tar.gz
add a section about PR
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ca95eb4..3382a33 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -66,7 +66,6 @@ Explain the problem and include additional details to help maintainers reproduce
This text has been largely inspired by the Atom contributing notes, which are amazingly complete.
-
## Styleguides
These sections tend to bore people. But if you don't follow them, it slows
@@ -122,6 +121,12 @@ Some general guidelines:
* Tests must be documented: Just add a comment block to the top of the file
with a short description and any existing bugs/URLs.
+#### CI
+
+If we are lucky enough to get pull request (PR) from you, we will do our best to support your efforts to get it in. As part of this, we setup a CI using github actions, which will be executed on new PR. Please check out the results of your PR to see if anything went wrong (it has Linux, MacOS and Windows OSes support). The CI must be green for a PR to be considered.
+
+See [the github PR documentation]{https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request} for more details about how to create a pull request.
+
### Documentation Styleguide
Do everything in markdown. It's readable even in plain text, and converts