Skip to content

Commit

Permalink
Added CONTRIBUTING.md file.
Browse files Browse the repository at this point in the history
  • Loading branch information
Scott Straughan committed Mar 2, 2023
1 parent 4c99a6c commit f9991ac
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Contributing to SYCLOPS-Website

## Pull requests

We really appreciate all pull requests to syclops-website, but we also have a few
guidelines in place to help keep the project consistent and reduce the noise in
commits, pull requests and code. Hopefully these guidelines are clear and easy
to follow, if not then feel free to add an issue to address this.

Before starting any development please make an issue to communicate your intent
and ensure that you are not duplicating work.

### Formatting

Please ensure that any contributions are formatted using the following
guidelines:

* Empty line at the end of each plaintext file
* Use "LF" line endings
* Use 4 character spaces (unless file prefers 2 characters such as .yml files)
* Following the naming conventions of the files currently in the repository
* For images, PNG is preferred although for larger images you can use JPEG.
* For source files, a line length of 120 is encouraged

### Pull request guidelines

* Submit any pull request to the `main` branch, unless you are really sure
you need to push your changes elsewhere.

* Unless your pull request is trivial, expect comments and suggestions on your
pull request. We will provide feedback as soon as possible.

* We cannot accept or test any pull request with merge conflicts, so please fix
these before submitting your pull request.

* Please ensure pull requests are small and focussed. This means that they
should only address a single feature, change or bug fix. Larger pull requests
trying to fix multiple things at once should be split into smaller pull
requests.

* All tests must pass before a pull request is accepted.

* If your pull request adds a new feature, please make sure that you add new
test cases to cover this feature.

### Commit guidelines

* In your commit messages, the first line should be a short summary of the
changes. Following this should be an empty line, then the remaining commit
message explaining the changes in more detail.

* Use the present tense to say what the commit changes.

* Check for any unnecessary whitespace changes with `git diff --check` before
committing your changes.

0 comments on commit f9991ac

Please sign in to comment.