Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 2.21 KB

Contributing

First of all, thank you for considering to contribute this project! We would be thrilled if you decide to contribute on any level. A collaborative work is essential for keeping it great, and improve the term cloud robotics.

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.

Architecture and Roadmap

robolaunch uses the approach of open-architecture. Architecture and roadmap details will be added to wiki page of this project.

Creating An Issue

You can use issue forms to create issues. There are two types of issue forms and they'll help you to explain feature suggestions and bugs.

  • Feature Request
  • Bug Report

Submitting A Pull Request

1. Fork and clone the repository.

2. Create a new branch: git checkout -b my-branch-name

3. Make your change and remember to add tests.

4. Build the project locally and run local tests.

5. Push to your fork and submit a pull request using pull request template.

6. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • State the issues that your pull request fixes or satisfies.
  • Write tests. (or define test requirements)
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, submit them as separate pull requests.
  • Use Conventional Commit format when typing a commit message (<type>[optional scope]: <description>). Start your description with an emoji you find related to that commit.
  • Follow style guide when writing your code.

Resources