Skip to content

Latest commit

 

History

History
107 lines (62 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

107 lines (62 loc) · 3.67 KB

Contribution Guidelines for KiteModels.jl

Welcome to the KiteModels.jl community! We appreciate your interest in contributing. These guidelines will help you get started and ensure your contributions are effective and welcome.

How to Contribute

  1. Choose Your Contribution Type

  • Code: Fix bugs, add features, or improve performance.

  • Documentation: Write or update documentation, docstrings, tutorials, or examples.

  • Tests: Add new tests or improve existing ones.

  • Bug Reports: File issues for bugs you find.

  • Feature Requests: Suggest new features or improvements.

License

By contributing code to KiteModels.jl, you are agreeing to release that code under the MIT License or the MPL-2.0 License.

  1. Get Set Up

  • Install Julia: Make sure you have a recent version of Julia installed. Use juliaup to install Julia.

  • Fork the Repository: Click "Fork" on the KiteModels.jl GitHub page.

  • Clone Your Fork: Clone your fork to your local machine.

  • Set Up the Development Environment as explained in the advanced documentation

  1. Make Your Changes

  • Follow Code Style: Adhere to the style conventions used in the project.

  • Document Your Code: Add or update docstrings and documentation as needed.

  • Write Tests: Include tests for new features or bug fixes.

  1. Submit Your Contribution

  • Commit Your Changes: Use clear, descriptive commit messages.

  • Push to Your Fork: Push your branch to your GitHub fork.

  • Open a Pull Request (PR): Submit a PR to the main KiteModels.jl repository.

  • Describe Your Changes: Clearly explain what you changed and why.

  1. Review and Improve

  • Respond to Feedback: Be open to suggestions and make requested changes.

  • Stay Engaged: Monitor your PR for comments and questions.

Code Style and Quality

  • Follow Julia conventions: Use consistent naming, indentation, and style.

  • Document Your Work: Ensure all new code is well-documented.

  • Test Thoroughly: Make sure your changes do not break existing functionality.

Reporting Issues

  • Check for Duplicates: Search existing issues before reporting a new one.

  • Provide Details: Include steps to reproduce, error messages, and relevant environment details.

Getting Help

  • Community Support: Ask questions on the Julia Discourse forum or the KiteModels.jl issue tracker.

  • Code of Conduct: Be respectful and inclusive in all interactions.

If you want to contribute a new kite model, you can get chat support via Signal. Just create an issue explaining your idea first.

Additional Resources

  • GitHub Guide: Learn how to use Git and GitHub for contributions.

  • Julia Documentation: Read the Julia contributor guide for more tips.

Releases

Before creating a new release, please check

  • that all tests pass
  • that all examples are part of the menu
  • that all examples in the menu work
  • update create_sys_image2.jl by comparing it with create_sys_image.jl using meld
  • make sure that the scripts
    • test_installation
    • test_installation2 and
    • test_installation3 work
  • execute meld README.md docs/src/index.md and make sure both are up-to-date
  • test the installation on Linux for both Julia 1.10 and the latest stable Julia version
  • test the installation on Windows after deleting the .julia folder
  • run pipx run reuse lint and make sure all files have a license attached; See: https://reuse.readthedocs.io/en/latest/readme.html