Contributing to ForColormap
Contributions to ForColormap are welcome and thanks for taking the time to help improve the project!
Table of Contents
How to Contribute?
Reporting Issues
If you encounter any problems, please open an issue on GitHub. Be sure to include detailed information about the issue.
Suggesting Enhancements
Do you have ideas for improving ForColormap? Please open an issue on GitHub and describe your proposed enhancements in detail.
Implementing Changes and Adding Features
If you'd like to add new features, fix bugs, or enhance existing functionality, consider submitting a pull request (PR). Here's how to proceed:
- Fork the repository and create a new branch from
main to work on your changes.
- Implement your modifications and enhancements.
- Ensure that your code adheres to the project's coding style and guidelines.
- Write clear and descriptive commit messages.
- Submit your PR with an explanation of the changes introduced.
Sharing Examples
Contribute to ForColormap by submitting a pull request (PR) with examples. Ensure that your examples are documented.
Styleguides
Code Style
- Maintain consistency with the existing code style and structure.
- Write clear, concise, and well-commented code.
- Thoroughly test your changes before submission.
Documentation
Git Commit Messages
Use the Conventional Commits specification to format your commit messages. This helps keep the project history readable and enables automatic changelog generation and versioning.
Format:
<type>(optional-scope): <description>
[optional body]
Guidelines:
- Keep the subject line under 72 characters.
- Use lowercase for
<type> and <scope>.
Common <type> values:
- feat: a new feature
- fix: a bug fix
- refactor: code change that neither fixes a bug nor adds a feature
- docs: documentation only changes
- style: changes that do not affect the meaning of the code (white-space, formatting, etc.)
- perf: a code change that improves performance
- chore: other changes that don't modify
src, example or test files