Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 3.18 KB

CONTRIBUTING.md

File metadata and controls

79 lines (55 loc) · 3.18 KB

Contributing to TREX-CoE Containers

We warmly welcome contributions from the community to the TREX-CoE Containers project! Whether it's improving documentation, adding new features, or reporting issues, your help is invaluable to us. This document outlines how you can contribute.

Getting Started

Before you begin, please ensure you have an understanding of how Apptainer (Singularity) containers work and are familiar with the TREX-CoE software suite. If you're new, consider going through the Apptainer documentation and the main TREX-CoE project website to get up to speed.

How to Contribute

Reporting Issues

If you encounter any bugs or issues, or if you have a suggestion for improving the containers, please open an issue through the GitHub issue tracker. Be sure to include:

  • A clear and descriptive title.
  • A detailed description of the issue or suggestion.
  • Steps to reproduce the bug, if applicable.
  • Any relevant logs or error messages.

Contributing Code

We accept contributions in the form of pull requests (PRs). If you're looking to contribute code, please follow these steps:

  1. Fork the Repository: Click the "Fork" button at the top right of this page to create your own copy of the repository.
  2. Clone Your Fork: Clone your fork to your local machine using git clone.
  3. Create a Branch: Before making your changes, create a new branch using git checkout -b your-branch-name.
  4. Make Your Changes: Add your changes to the branch, adhering to the coding standards and conventions of the project.
  5. Commit Your Changes: Commit your changes using a clear and descriptive commit message.
  6. Push Your Changes: Push your changes to your fork on GitHub.
  7. Open a Pull Request: Go to the original repository, and you'll see a prompt to open a pull request. Fill in the details of your PR, explaining the changes you've made and their purpose.

Code Review Process

Once you've submitted a PR, the project maintainers will review your contributions. They may provide feedback or request changes. Engage in discussions, and if changes are requested, make them in your branch and push the updates. Once your PR is approved, a maintainer will merge it into the main repository.

Coding Guidelines

  • Code Quality: Write clean, maintainable, and efficient code.
  • Documentation: Update the README.md or other documentation as necessary to match your changes.
  • Testing: If you're adding new features, include tests that cover your changes.

Community Guidelines

We strive to maintain a welcoming and inclusive environment for everyone. We expect all participants to treat each other with respect and to follow our community guidelines, which include:

  • Be considerate and respectful.
  • Work collaboratively with others.
  • Be open to feedback and willing to make changes.
  • Avoid offensive or harmful language.

Questions or Suggestions

If you have any questions or suggestions on how we can improve the contribution process, please feel free to open an issue.

Thank you for considering contributing to the TREX-CoE Containers project. Your efforts help make the project better for everyone!