Skip to content

Commit 2dfaf8b

Browse files
committed
doc: Add contributing guide
This commit introduces a contributing guide to help developers understand the process for contributing to libcsp, including coding standards, commit message guidelines, and the pull request review process. Signed-off-by: Yasushi SHOJI <[email protected]>
1 parent 29bf183 commit 2dfaf8b

File tree

3 files changed

+44
-1
lines changed

3 files changed

+44
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The latest version of the /doc folder is compiled to HTML and hosted on:
7171
Thank you for considering contributing to libcsp! We welcome
7272
contributions from the community to help improve and grow the
7373
project. Please take a moment to review our
74-
[guidelines](./doc/git-commit.md) before opening a Pull Request!
74+
[guidelines](./doc/contributing.md) before opening a Pull Request!
7575

7676
## Software license
7777

doc/contributing.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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

doc/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ hooks
6060
:caption: Development
6161
:hidden:
6262
63+
contributing
6364
codestyle
6465
git-commit
6566
structure

0 commit comments

Comments
 (0)