Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 2.38 KB
Raw

Contributing to ifopt

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

We are grateful to anyone who decides to actively engage in this project. This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

Question or Issue?

  • ROS Answers: If you want to ask a general usage question, please do this at ROS Answers using the tag ifopt. Asking there has the following advantages:

    • There are many more people reading questions there so your chances on getting an answer and in a timely manner are much higher.
    • In the future other users will search there for similar problems and can find your question and the potential answers.

  • Issue tracker: In case you want to report bugs, request features or closely related to the code, the Issue tracker in this repo is the way to go.

How Can I Contribute?

Unsure where to begin contributing to ifopt? You can start by looking through these beginner and help-wanted issues:

  • Good first issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Further ideas might include:

  • writing interfaces to additional solvers
  • reporting bugs
  • enhance documentation
  • add unit tests

Please follow the Google Style Guide when writing your C++ Code for this project.

Submitting a pull request

Please create a pull request from your forked repo to the master branch.

  • Keep pull requests small, focussing on one specific issue.
  • Describe concisely what you are solving and reference the corresponding issue.
  • Include weblinks to relevant information.
  • Include screenshots and animated GIFs in your pull request whenever possible.

We are performing automatic pull request testing, so if you see anything red, please read through the log and update your pull request until the tests pass.