Skip to content

Commit cf36c0b

Browse files
authored
Add documentation about contributing (#184)
Signed-off-by: Jacob Perron <jacob@openrobotics.org>
1 parent bc4394c commit cf36c0b

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
1+
# Contributing to ROS 2 Java
2+
3+
This document contains rules and guidelines for contributing to the ROS 2 Java project.
4+
5+
## How to contribute
6+
7+
Here are a few things you can do to contribute to the project:
8+
9+
1. Report a bug by opening an issue on GitHub
10+
2. Even better, open a **pull request** fixing the bug!
11+
12+
If you open a ticket, be patient while waiting for a response; The ROS 2 Java team is small.
13+
While you wait, other excellent ways to contribute include:
14+
15+
1. Leave constructive feedback on an open pull request
16+
2. Try to reproduce an existing bug report and leave a comment
17+
18+
## Pull requests
19+
20+
Each pull request must satisfy the following requirements before it can be merged:
21+
22+
1. Target the latest developement branch (`main`)
23+
2. Have one approval from a maintainer
24+
3. Continuous integration (CI) is building and passing tests
25+
- This should be automatically triggered upon opening a pull request
26+
27+
## Note about license
28+
129
Any contribution that you make to this repository will
230
be under the Apache 2 License, as dictated by that
331
[license](http://www.apache.org/licenses/LICENSE-2.0.html):

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,8 @@ Although the `ros2_java_android.repos` file contains all the repositories for th
159159
-DCMAKE_FIND_ROOT_PATH="${PWD}/install"
160160

161161
You can find more information about the Android examples at https://github.com/ros2-java/ros2_android_examples
162+
163+
## Contributing
164+
165+
Contributions are more than welcome!
166+
If you'd like to contribute to the project, please read [CONTRIBUTING](CONTRIBUTING.md) for contributing guidelines.

0 commit comments

Comments
 (0)