Skip to content

Contributing

GEMS welcomes any contribution in all forms.

  • For contributing in GEMS code, please find the following instructions :
Code contribution details
  • GEMS repositories containing code:
  • Steps to contribute:
    • Fork the repository - Create your own copy of the GEMS repository
    • Clone your fork - git clone https://github.com/YOUR_USERNAME/GEMS.git
    • Create a feature branch - git checkout -b feature/your-feature-name
    • Make your changes - Follow the existing code style and conventions
    • Write tests - Ensure your code is covered by appropriate tests
    • Commit your changes - Use clear, descriptive commit messages
    • Push to your fork - git push origin feature/your-feature-name
    • Open a Pull Request - Submit your changes for review
  • For contributing in GEMS documentation, please use the following instructions :
Documentation contribution details
  • GEMS repository containing documentation:
  • Steps to contribute:
    • Fork the repository - Create your own copy of the GEMS documentation repository
    • Clone your fork - git clone https://github.com/YOUR_USERNAME/GEMS.git
    • Create a feature branch - git checkout -b docs/your-doc-name
    • Edit documentation - Use Markdown format and follow the existing structure
    • Review your changes - Test the documentation locally if possible
    • Commit your changes - Use clear, descriptive commit messages
    • Push to your fork - git push origin docs/your-doc-name
    • Open a Pull Request - Submit your documentation updates for review, with the label "Documentation"
  • For adding or suggesting changes on ready-to-use libraries and examples:
Libraries and Examples contribution details
  • GEMS repository containing libraries and examples:
  • Steps to contribute:
    • Fork the repository - Create your own copy of the GEMS documentation repository
    • Clone your fork - git clone https://github.com/YOUR_USERNAME/GEMS.git
    • Create a feature branch - git checkout -b docs/your-doc-name
    • Write your library - Put your new yml file in libraries folder
    • Test your library - Test your library with at least one example study and provide it inside the resources folder
    • Commit your changes - Use clear, descriptive commit messages
    • Push to your fork - git push origin docs/your-doc-name
    • Open a Pull Request - Submit your documentation updates for review, with the label "Libraries"