@@ -10,6 +10,19 @@ Contributions
10
10
11
11
*
12
12
13
+ Thank you for considering contributing to the this project. We welcome contributions from everyone.
14
+ Before you start contributing, please read the following guidelines. They will help you to understand
15
+ the different ways you can contribute to the project. And this already starts with reporting an issue.
16
+
17
+ Report an issue
18
+ ===============
19
+
20
+ If you find a bug in the code, or have a suggestion for a new feature, please report it in the issue tracker.
21
+ This will help us to understand the problem you are facing. This will also make sure that you are not working
22
+ on something that might be rejected later. Please use the issue templates to report the issue.
23
+
24
+ Now that you have reported the issue, you can start working on the issue. For bugs its always good to have a :ref: `failing test <writing-tests >`.
25
+ to reproduce the issue.
13
26
14
27
Clone the mono repository
15
28
=========================
@@ -34,5 +47,28 @@ For instance, to run the pre-commit checks, you can run::
34
47
35
48
make PHP_BIN=php pre-commit-test
36
49
37
- Submit a Pull Request
38
- =====================
50
+ Submit changes (Pull Request)
51
+ =============================
52
+
53
+ To submit a change, you need to create a pull request against the mono repository. Pull requests must
54
+ always target the ``main `` branch. We will not accept pull requests against other branches unless discussed
55
+ with the maintainers. The pull request should pass the tests and checks. you can run the checks locally like described
56
+ in :ref: `Run the tests <run-the-tests >`.
57
+
58
+ If all checks pass, the pull request
59
+ will be reviewed, we try to do this as fast as possible, but as this is a community project, it might take
60
+ while before we can review your pull request.
61
+
62
+ Documentation
63
+ =============
64
+
65
+ As this is a documentation project, we also welcome contributions to the documentation. If you find a typo or an
66
+ error in the documentation, please report it in the issue tracker. If you want to fix it yourself, you can create a pull
67
+ request with the changes. We will review the changes and merge them if they are correct.
68
+
69
+ Our documentation is written in reStructuredText and built with phpDocumentor. And can be found in the ``docs `` directory.
70
+
71
+ Need help?
72
+ ==========
73
+
74
+ If you need help with contributing, please ask in the issue tracker. We are happy to help you with your contribution.
0 commit comments