# Contributing to Gosl

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing to Gosl and its packages. These are mostly
guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in
a pull request.

#### Table Of Contents

[TODO List](#TODO List)

[Code of Conduct](#code-of-conduct)

## TODO List

1.  Create more examples using all packages
2.  Apply English language editing to GitHub pages
3.  Finalise the Octree structure in `gm`
4.  Improve the computational geometry functions in `gm`
5.  Finalise the functions `WireLength` and `DistAlongWire` in `gm`
6.  Wrap more functions in `oblas` and `mkl`
7.  Reimplement the the tensors (`tsr`) package
8.  Implement a wrapper to ARPACK
9.  Implement more functions from [Numerical Recipes](http://numerical.recipes) in `num`
10. Improve the database of functions (`dbf`) with better explanation of functions and more functions
11. Implement triagulation methods in `msh/tri`
12. Add a new package called `msh/tet` to wrap [TetGen](http://wias-berlin.de/software/index.jsp?id=TetGen&lang=1)
13. Implement parallel graph routines (using channels) in `graph`
14. Add more probability distributions to `rnd`
15. Wrapp more VTK classes in `vtk`
16. Implement multistep ODE solves in `ode`
17. Finalise and publish package `pde`

## Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers
pledge to making participation in our project and our community a harassment-free experience for
everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level
of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

This Code of Conduct follows the [Contributor Covenant][https://www.contributor-covenant.org],
version 1.4.

Add file with todo list, contributing guidelines, and code of conduct
Add file with todo list, contributing guidelines, and code of conduct
