-
Notifications
You must be signed in to change notification settings - Fork 39
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
1 changed file
with
38 additions
and
0 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,38 @@ | ||
Contributing to LuaBridge3 | ||
========================== | ||
|
||
Thank you for considering contributing to LuaBridge3! We appreciate your interest in helping us make this library better. | ||
|
||
The following is a set of guidelines for contributing to LuaBridge3. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. | ||
|
||
Getting Started | ||
--------------- | ||
- Fork the repository and clone it locally. | ||
- Create a branch for your changes: `git checkout -b my-branch-name`. | ||
- Make your changes and commit them: `git commit -am 'Add some feature'`. | ||
- Push your changes to your fork: `git push origin my-branch-name`. | ||
- Open a pull request against the main branch of the original repository. | ||
|
||
Testing | ||
------- | ||
We use Google Test for unit testing. Before submitting a pull request, please make sure that all tests pass by running all variants of them. | ||
|
||
Documentation | ||
------------- | ||
We use Doxygen to provide inline documentation for this project. Please make sure that your code is documented using Doxygen comments. The documentation should explain what the code does, how to use it, and any other relevant information. | ||
|
||
Pull Request Guidelines | ||
----------------------- | ||
- Pull requests should be focused on a single feature or bug fix. | ||
- Please include a summary of the change and which issue is fixed or which feature is added. | ||
- If the pull request adds functionality, please include tests for it. | ||
- Code coverage should never decrease. If it does, consider writing more tests. | ||
- Pull requests should be made against the main branch. | ||
|
||
Code of Conduct | ||
=============== | ||
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. | ||
|
||
License | ||
======= | ||
By contributing to LuaBridge3, you agree that your contributions will be licensed under the MIT License. |