If you would like to contribute to the project you could do that in various ways. Some examples are listed below:
If you would like to contribute to the project you could do that in various ways. Some examples are listed below:
- Create issues for bugs, improvements and/or features.
- Create issues for bugs, improvements and/or features.
- Fix a bug or develop an improvement and/or feature yourself. Clone the repository, create a new branch when done create a merge request.
- Fix a bug or develop an improvement and/or feature yourself. Clone the repository, create a new branch and when done create a merge request.
- Report typos and/or inconsistencies in the documentation.
- Report typos and/or inconsistencies in the documentation.
- Contribute to the documentation and/or the Wiki of the project.
- Contribute to the documentation and/or the Wiki of the project.
- Create a CI configuration for automated testing, or develop unit tests.
- Create a CI configuration for automated testing, or develop unit tests.
...
@@ -17,5 +17,5 @@ To try and maintain a coherent style in the codebase you are encouraged to use t
...
@@ -17,5 +17,5 @@ To try and maintain a coherent style in the codebase you are encouraged to use t
Irrespective of style, it is highly advisable to name your variables in a meaningful manner and keep them as short as possible while still communicating their purpose. Comments are highly recommended in your code, especially where they can facilitate a better understanding of the code and the intent of the developer. Over-commented code is better than under-commented code.
Irrespective of style, it is highly advisable to name your variables in a meaningful manner and keep them as short as possible while still communicating their purpose. Comments are highly recommended in your code, especially where they can facilitate a better understanding of the code and the intent of the developer. Over-commented code is better than under-commented code.
## ***IMPORTANT***
## ***IMPORTANT***
The project is licensed under the [**MIT License**](https://mit-license.org/). If you are unable or unwilling to work contribute under this license do **not**contribute as the content of this project must remain under the same license.
The project is licensed under the [**MIT License**](https://mit-license.org/). If you are unable or unwilling to contribute code under this license do **not**add any code to the repository. The content of this project must remain under the same license.
