Welcome! This document explains some of the ways you can contribute to InfiniteOpt.
This project and everyone participating in it is governed by the InfiniteOpt Code of Conduct. By participating, you are expected to uphold this code.
Our documentation is by no means perfect, and we welcome help in making it better. Chances are if you have had to ask us questions, then our documentation can be improved and moreover you're probably the best person to help since it was your question.
The docs are written in Markdown and are built using Documenter.jl. You can find the source code to of all the docs here.
If your change is small (like fixing typos, or one or two sentence corrections),
the easiest way to do this is via Github's online editor. (Github has
help
on how to do this.) Moreover, the editor can be activated on the page of interest
by clicking on the Edit on GitHub button at the top of the documentation page.
If your change is larger, or touches multiple files, you will need to make the change locally and then use Git to submit a pull request. (See our Development page for more information and for the step by step explanation.)
Also, feel free to ask a question.
Another way to contribute to InfiniteOpt is to file bug reports. Make sure you read the info in the box where you write the body of the issue before posting.
Another way to contribute is to let us know of something you would like added and/or changed in InfiniteOpt. To do this please see feature requests. Please make sure you read the info and complete the template before posting.
Finally, you can also contribute code to InfiniteOpt!
If you do not have experience with Git, Github, and Julia development, the first steps can be a little daunting. However, there are lots of tutorials available online to help you get started. Please visit our developer docs to walk you through getting started.
Once you are familiar with Git, the workflow for contributing code to InfiniteOpt is along the lines of the following:
- Find an open issue (or open a new one) for the problem you want to solve
- Make your changes locally. (Again our RoadMap explains this). Make sure you:
- Follow the style guide
- Add tests and documentation for any changes or new features
- Submit a pull request to Github
- Update your pull request, responding to any comments
Remember to be patient and polite; you may get a lot of comments on your pull request! However, do not be afraid! A lot of comments means that people are willing to help you improve the code that you are contributing to InfiniteOpt.
Thank you for contributing to InfiniteOpt, you're help is greatly valued and appreciated!