Contribution Guidelines

Thank you for considering contributing to the NorESM TinkerTool project! We welcome contributions from the community to help improve the tool and make it more useful for everyone. Below are some guidelines to help you get started.

How to Contribute

1. Fork the Repository: Start by forking the repository to your own GitHub account.
2. Create a Branch: Create a new branch for your feature or bug fix. Use a descriptive name for your branch, such as feature/new-feature or bugfix/fix-issue.
3. Make Your Changes: Make the necessary changes to the codebase. Ensure that
   • Your code follows the existing style and conventions.
   • You have added tests for any new features or bug fixes.
4. Commit Your Changes: Commit your changes with a clear and concise commit message that describes what you have done.
5. Push to Your Fork: Push your changes to your forked repository on GitHub.
6. Create a Pull Request: Open a pull request from your branch to the main repository. Provide a detailed description of your changes and why they are necessary.

Suggestions for improvement are also welcome! If you have an idea for a new feature or an improvement to an existing one, feel free to open an issue to discuss it. Feedback helps understand which features are most important to users and can guide the development of the tool.

Code of Conduct

We ask that all contributors adhere to treat each other with respect and kindness. DO NO HARM.

License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project, which is MIT License.