-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Addition of contributing guide (#38)
* Added logo to README.md * Addition of CONTRIBUTING.md * Runs job on every PR * Run on every PR * Delete unneeded files
- Loading branch information
1 parent
d771929
commit 31a0d1e
Showing
6 changed files
with
24 additions
and
109 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,6 @@ on: | |
push: | ||
branches: [ "main" ] | ||
pull_request: | ||
branches: [ "main" ] | ||
workflow_dispatch: | ||
|
||
env: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
TLDR: The expected, merge into main, reference issues in PRs. | ||
|
||
## Documentation | ||
|
||
Out of source (non-inline) documentation such as design diagrams should be added to the `docs` folder as should images for readmes or anything else that is not within the `docs` folder. | ||
|
||
## Code | ||
All source code should be in C++ following best practices guidelines where possible (such as avoiding `new` and `delete`). | ||
<!-- start formatting --!> Indentation should be done with spaces not tabs and a trailing new line should be added to the end of each file (this makes the diffs cleaner). | ||
<!-- A formatter will be added then replace with the following: --> | ||
<!-- All code should be formatted using the included clang format file. If you disagree with the formatter please create a PR to change it. --> | ||
|
||
|
||
## PRs | ||
|
||
PRs should have a base branch of (and merge into) main with no merge conflicts. Please keep your branch as up to date as possible. | ||
|
||
Your PR should include the issue number (e.g. "closes #1234"), there is no need to do so in commit messages. | ||
|
||
## Code of Conduct | ||
Our code of conduct is "be kind to eachother" unless otherwise stated. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.