|
1 | 1 | # Contributing to codeplay.com Website |
2 | 2 |
|
3 | | -## Pull requests |
4 | | - |
5 | | -We really appreciate all pull requests to this project, but we also have a few guidelines in place to help keep the |
6 | | -project consistent and reduce the noise in commits, pull requests and code. Hopefully these guidelines are clear and |
7 | | -easy to follow, if not then feel free to add an issue to address this. |
8 | | - |
9 | | -Before starting any development please make an issue to communicate your intent and ensure that you are not duplicating |
10 | | -work. |
11 | | - |
12 | | -### Formatting |
13 | | - |
14 | | -Please ensure that any contributions are formatted using the following guidelines: |
15 | | - |
16 | | -* Empty line at the end of each plaintext file |
17 | | -* Use "LF" line endings |
18 | | -* Use 2 character spaces as much as possible |
19 | | -* Following the naming conventions of the files currently in the repository |
20 | | -* For images, webp is preferred although for larger images you can use JPEG. |
21 | | -* For source files, a line length of 120 is encouraged |
22 | | -* Following the same formatting as currently in use |
23 | | - |
24 | | -### Pull request guidelines |
25 | | - |
26 | | -* Submit any pull request to the `main` branch, unless you are really sure you need to push your changes elsewhere. |
27 | | - |
28 | | -* Unless your pull request is trivial, expect comments and suggestions on your pull request. We will provide feedback as |
29 | | - soon as possible. |
30 | | - |
31 | | -* We cannot accept or test any pull request with merge conflicts, so please fix these before submitting your pull |
32 | | - request. |
33 | | - |
34 | | -* Please ensure pull requests are small and focussed. This means that they should only address a single feature, change |
35 | | - or bug fix. Larger pull requests trying to fix multiple things at once should be split into smaller pull requests. |
36 | | - |
37 | | -* All tests must pass before a pull request is accepted. |
38 | | - |
39 | | -* If your pull request adds a new feature, please make sure that you add new test cases to cover this feature. |
40 | | - |
41 | | -### Commit guidelines |
42 | | - |
43 | | -* In your commit messages, the first line should be a short summary of the changes. Following this should be an empty |
44 | | - line, then the remaining commit message explaining the changes in more detail. |
45 | | - |
46 | | -* Use the present tense to say what the commit changes. |
47 | | - |
48 | | -* Check for any unnecessary whitespace changes with `git diff --check` before committing your changes. |
| 3 | +We do not currently accept contributions. |
0 commit comments