Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

43 lines (33 loc) · 2.18 KB

Contributing

Any contribution that you make to this repository will be under the Apache 2 License, as dictated by that license:

5. Submission of Contributions. Unless You explicitly state otherwise,
   any Contribution intentionally submitted for inclusion in the Work
   by You to the Licensor shall be under the terms and conditions of
   this License, without any additional terms or conditions.
   Notwithstanding the above, nothing herein shall supersede or modify
   the terms of any separate license agreement you may have executed
   with Licensor regarding such Contributions.

Please add the following header to the top of a new file:

Copyright 2021 Halodi Robotics

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Contribution guidelines

To contribute to the code in this repository please follow a standard git workflow, an example of which we include below. You can expect a more formal definition of this workflow as soon as we have more out-of-house contributors to this project.

  1. If you have a problem with some already written code, or are unsure about something, create an issue an assign the repository maintainer.
  2. After reviewing your issue the maintainer will either fix the problem themselves or will request you to contribute towards a solution.
  3. To contribute, checkout a new branch of suitable name and develop there.
  4. Before opening a pull request, test you code thoroughly via the procedure outlined at the end of the README, once all tests are passed you can open a pull request and assign the maintainer as reviewer.
  5. Await a response.