Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

65 lines (43 loc) · 2.79 KB
Raw

Contributing to ugv_nav4d

Please inform the maintainer as early as possible about your planned feature developments, extensions, or bugfixes that you are working on. An easy way is to open an issue or a pull request in which you explain what you are trying to do.

Pull Requests

The preferred way to contribute to ugv_nav4d is to fork the main repository on GitHub, then submit a "pull request" (PR):

  1. Create an account on GitHub if you do not already have one.

  2. Fork the project repository: click on the 'Fork' button near the top of the page. This creates a copy of the code under your account on the GitHub server.

  3. Clone this copy to your local disk:

     $ git clone [email protected]:YourLogin/ugv_nav4d.git

  4. Create a branch to hold your changes:

     $ git checkout -b my-feature

    and start making changes. Never work in the main branch!

  5. Work on this copy, on your computer, using Git to do the version control. When you're done editing, do::

     $ git add modified_files
 $ git commit

    to record your changes in Git, then push them to GitHub with::

    $ git push -u origin my-feature

Finally, go to the web page of the your fork of the ugv_nav4d repo, and click 'Pull request' to send your changes to the maintainers for review. request.

Merge Policy

Usually it is not possible to push directly to the master branch of Software Name for anyone. Only tiny changes, urgent bugfixes, and maintenance commits can be pushed directly to the master branch by the maintainer without a review. "Tiny" means backwards compatibility is mandatory and all tests must succeed. No new feature must be added.

Developers have to submit pull requests. Those will be reviewed by at least one other developer and merged by the maintainer. New features must be documented and tested. Breaking changes must be discussed and announced in advance with deprecation warnings.

Project Roadmap

Please see the issues for planned future changes.

Funding

The ugv_nav4d library was initiated and is currently developed at the Robotics Innovation Center of the German Research Center for Artificial Intelligence (DFKI) in Bremen, together with the Robotics Group of the University of Bremen. The development was started in the scope of the Entern project (50RA1406), which has been funded by the German Aerospace Center (DLR) with funds from the German Federal Ministry for Economic Affairs and Climate Action (BMWK).