Skip to content

Commit 302dc07

Browse files
committed
Add a CONTRIBUTING.md file
1 parent 1de0457 commit 302dc07

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Contributing to perl
2+
3+
There are several documents trying to help you on your way to contribute to our project,
4+
including F<pod/perlhack.pod>, F<pod/perlhacktips.pod> and C<pod/perlhacktut.pod>.
5+
6+
Please be mindful of `CODE_OF_CONDUCT.md` and `AI_POLICY.md`.
7+
8+
## In brief:
9+
10+
* Before opening any non-trivial pull request, open an issue first. Starting to code before there's agreement on how to approach something often leads to wasted effort.
11+
12+
* Be sure run C<make test» before opening a PR, or C<TEST_JOBS=$(nproc) make -j$(nproc) test_harness> if you're in a hurry.
13+
14+
* If this is your first contribution, please don't forget to run `perl Porting/updateAUTHORS.pl` after committing (and committing the result), otherwise the F<AUTHOR> file tests will start failing.

0 commit comments

Comments
 (0)