Contributions are welcomed via pull requests on GitHub. Prior to writing a new example, please review the examples outline and determine where your example best fits. We encourage you to propose your new example in an issue and discuss your plans with the fresnel developer community to ensure that the planned development meshes well with the directions and standards of the project. Follow the general guidelines outlined below when writing your example.
File a GitHub issue to report problems with or suggest changes to an example. If you are able to implement the fix yourself, please do so and submit a pull request on GitHub. Follow the general guidelines outlined below when modifying examples.
Examples should be written as Jupyter notebooks with an appropriate mixture of code and explanatory Markdown cells.
All examples should follow a consistent style. See the existing notebooks which demonstrate this style.
Include notebook output in your commits, but keep the repository size reasonable. fresnel does not re-run notebooks when building documentation, so the committed output is exactly what the user will see.
- Only commit changes for notebooks that you materially change
- Feel free to make as many commits as needed during the review process, your pull request will be squash merged
- Do not commit PNG files or other output files that the examples produce
Notebook files should be named like 00-Example-Title.ipynb and placed in the appropriate (sub-)section directory.
Use - instead of spaces. The leading digits should be chosen so that the example appears in the correct place in
the order displayed by ls, github, and jupyter. See the examples outline for the outline of current examples.
Add new examples to the examples outline.