|
|
# Contributing Guidelines
|
|
|
|
|
|
Thank you for contributing to the Wiki! Please follow the guidelines below to maintain consistency in the project, especially for visualizations.
|
|
|
Thank you for contributing to the Wiki! Please follow the guidelines below to maintain consistency in the project, especially for models, visualizations, and documentation.
|
|
|
|
|
|
## General Guidelines
|
|
|
|
... | ... | @@ -10,6 +10,18 @@ Thank you for contributing to the Wiki! Please follow the guidelines below to ma |
|
|
|
|
|
3. **Commit Messages**: Use clear and concise commit messages that describe the changes you’ve made.
|
|
|
|
|
|
## Section Structure Requirements
|
|
|
|
|
|
When writing new sections, particularly for models or visualizations, ensure that you include the following subsections:
|
|
|
|
|
|
1. **When to Use**: Clearly explain under which circumstances or for which type of data/model the method or visualization should be applied.
|
|
|
|
|
|
2. **When Not to Use**: Describe scenarios where the method or visualization is inappropriate or could lead to confusion.
|
|
|
|
|
|
3. **Examples**: Provide at least one example (with code or visualization) demonstrating the correct usage of the method or visualization.
|
|
|
|
|
|
This structure will ensure that every section has clear guidance on applicability and examples for users to understand practical usage.
|
|
|
|
|
|
## Visualization Guidelines
|
|
|
|
|
|
To ensure uniformity, all visualizations should use the following font and color scheme:
|
... | ... | |