|
|
# Contributing Guidelines
|
|
|
|
|
|
Thank you for contributing to the Wiki! Please follow the guidelines below to maintain consistency in the project, especially for models, visualizations, and documentation.
|
|
|
Thank you for contributing to the Wiki! Please follow the guidelines below to maintain consistency.
|
|
|
|
|
|
## General Guidelines
|
|
|
|
|
|
1. **Use Markdown**: All documentation should be written using Markdown to ensure readability and consistency across the Wiki.
|
|
|
|
|
|
2. **File and Folder Structure**: If you want to create figures for the Wiki, make sure your code is saved in the `rcode` folder, and images are placed in the `images` folder.
|
|
|
1. **File and Folder Structure**: If you want to create figures for the Wiki, make sure your code is saved in the `rcode` folder, and images are placed in the `images` folder and appropriate subfolder. You can link to images by including the relative path to the image folder
|
|
|
|
|
|
```markdown
|
|
|

|
|
|
```
|
|
|
|
|
|
3. **Commit Messages**: Use clear and concise commit messages that describe the changes you’ve made.
|
|
|
2. **Commit Messages**: Use clear and concise commit messages for large edits that describe the changes you’ve made.
|
|
|
|
|
|
## Section Structure Requirements
|
|
|
|
... | ... | @@ -26,8 +28,22 @@ When adding mathematical formulas to your documentation, please use one of the f |
|
|
|
|
|
1. **Plain Text**: For simple formulas, write them directly in plain text using basic symbols.
|
|
|
|
|
|
2. **Images**: For more complex formulas, use external tools like [Codecogs](https://www.codecogs.com/latex/eqneditor.php) to generate LaTeX equations as images (PNG/SVG). Upload these images to the `/images/formulas` folder of the repository and embed them in your documentation. BE SURE TO SAVE WITH A WHITE BACKGROUND {: width="400"}
|
|
|
(so users with dark mode can still read the content)
|
|
|
|
|
|
2. **LaTeX**: To render LaTeX formulas on the page, include the following code snippet at the beginning of your file:
|
|
|
|
|
|
```html
|
|
|
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
|
|
|
<script type="text/javascript" id="MathJax-script" async
|
|
|
src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js">
|
|
|
</script>
|
|
|
```
|
|
|
|
|
|
When including formulas, ensure each symbol is explained. For example:
|
|
|
|
|
|
- \( E = mc^2 \)
|
|
|
- \( E \): Energy
|
|
|
- \( m \): Mass
|
|
|
- \( c \): Speed of light
|
|
|
|
|
|
## Visualization Guidelines
|
|
|
|
... | ... | |