|
| 1 | +# Contributing to libcsp |
| 2 | + |
| 3 | +Thank you for your interest in contributing to libcsp! We welcome all |
| 4 | +contributions, whether they are bug fixes, new features, documentation |
| 5 | +improvements, or anything else that helps make libcsp better. |
| 6 | + |
| 7 | +## Guidelines |
| 8 | + |
| 9 | +### Coding Standards |
| 10 | + |
| 11 | +Please follow [the libcsp coding standards][1]. Consistent coding |
| 12 | +helps maintain the readability and quality of the project. |
| 13 | + |
| 14 | +### Commit Messages |
| 15 | + |
| 16 | +Please follow the [the libcsp Git Commit Guidelines][2]. Clear and |
| 17 | +concise git commit message helps maintainer when review and future |
| 18 | +developers to understand why the code is written as it is written. |
| 19 | + |
| 20 | +## Pull Request Review Process |
| 21 | + |
| 22 | +Your pull request will be reviewed by one or more maintainers. They |
| 23 | +may ask you to make changes before the pull request can be |
| 24 | +merged. Please be responsive to feedback and update your PR as needed. |
| 25 | + |
| 26 | +When you find any bugs in older branches, make sure to test them in |
| 27 | +the `develop` branch. If you find the same issue, file an issue or |
| 28 | +create a pull request against the `develop` branch. We will backport |
| 29 | +it to older branches if applicable. We may request you to update your |
| 30 | +existing PR or create a new one for older branches if necessary. |
| 31 | + |
| 32 | +If you don't find the same issue in `develop` branch, the issue might |
| 33 | +have been fixed in `develop` branch. Search it or ask it by opening an |
| 34 | +issue. We are always welcoming a new PR. |
| 35 | + |
| 36 | +## Getting Help |
| 37 | + |
| 38 | +If you need help or have questions about contributing, feel free to |
| 39 | +open an issue with "Q&A" label. |
| 40 | + |
| 41 | +[1]: ./codestyle.md |
| 42 | +[2]: ./git-commit.md |
0 commit comments