Contributing to QMC=Chem

Contributions to QMC=Chem are highly valued and play a crucial role in the continuous improvement and development of the project. Whether you are fixing bugs, adding new features, or improving documentation, your contributions are welcome. Here’s how you can contribute:

Reporting Bugs

  • Use GitHub Issues: If you encounter a bug while using QMC=Chem, please report it via the GitHub Issues page: QMC=Chem Issues.

  • Provide Detailed Information: When reporting a bug, include as much information as possible. This should cover the environment in which the bug occurred, steps to reproduce the issue, and any relevant logs or error messages.

Code Contributions

  • Codebase: QMC=Chem is primarily written in Fortran and utilizes the IRPF90 code generator. Familiarity with these technologies is beneficial for contributors.

  • Submit via GitHub Pull Requests: Contributions to the code should be submitted in the form of pull requests (PRs) to the QMC=Chem GitHub repository.

  • Follow Best Practices: Ensure your code adheres to the existing coding standards and practices in the project. This includes writing readable, well-documented code and following any specific guidelines provided by the project maintainers.

Process for Contributions

  1. Fork the Repository: Start by forking the QMC=Chem GitHub repository.

  2. Create a New Branch: Make your changes in a new branch in your forked repository.

  3. Develop and Test: Implement your changes or fixes and ensure they are thoroughly tested.

  4. Commit Changes: Commit your changes with clear and detailed commit messages.

  5. Submit a Pull Request: Once your changes are ready, submit a pull request to the main QMC=Chem repository. In your pull request description, explain the changes and their purpose.

Community Guidelines

  • Respectful Communication: Always communicate respectfully with other contributors and maintainers. Open source projects thrive on collaboration and respectful exchanges.

  • Constructive Feedback: When reviewing others’ contributions, provide constructive, helpful feedback and suggestions.

  • Inclusivity: The QMC=Chem community values inclusivity. Contributions from everyone, regardless of background or experience level, are encouraged.

—

By following these guidelines, you can effectively contribute to the development and improvement of QMC=Chem. Your contributions not only benefit the project but also the wider community of users and developers.