Skip to content

Contributing

A contribution can start with a question, an unclear explanation or an example whose answer seems wrong. Use the shared issue tracker to report a problem or propose work, including the relevant page, study or small example. Discussions is a place for usage questions and mathematical ideas.

Choose where to contribute

ContributionWhat helps us review it
TamerOp.jl: code or an optimizationExplain the changed behavior, provide relevant tests and make performance claims reproducible.
TamerOp-site: a lesson, example or correctionDescribe the audience and mathematical purpose, supply working examples and credit sources.
TamerOp-benchmarks: a benchmark or a run on another computerSupply the inputs, software versions, hardware, answer checks and raw results.

Fork the repository you want to change, work on a branch and open a pull request there. Link the shared issue when there is one. Early discussion helps us agree on the purpose of a substantial contribution; small corrections can arrive directly as pull requests.

Erik Novak reviews contributions and oversees their integration, including the final API, teaching presentation and releases. Contributors can concentrate on their code, example or measurement while Erik helps fit it into the project. Credit is retained when work is adapted, and substantial changes to its meaning are discussed with its author. If you are interested in becoming a maintainer, email erikmendesnovak@gmail.com.

Cite the work

The citation record provides the software citation; identify the version or commit used in your research. Mathematical and software sources are cited where their ideas are used, including the implementation bibliography. The changelog records changes to the library.