-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
28 additions
and
2 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 |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Contributing | ||
|
||
This project is meant to evolve over time be community contributions. | ||
Feel free to open a Pull Request or an issue to discuss any change or | ||
enhancement. | ||
|
||
## How to contribute. | ||
|
||
1. Open an issue on the topic you want to discuss about | ||
- Don't forget to add tags, it will be easier to understand the purpose of | ||
the issue ;). | ||
|
||
2. If you can, fork the repo, make the changes, and create a pull request. | ||
3. Test if it builds and works. Unit tests may be added later on. | ||
4. Don't forget documentation ! | ||
|
||
## Notes | ||
|
||
Any change to the code must respect the coding style. | ||
|
||
An `.eslintrc.yml` file is provided at the root of the repo to format the | ||
typescript code. | ||
|
||
A `.clang-format` file is provided in the `cppsrc/` folder to format the code. | ||
|
||
Any change is welcome ! |
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