Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

59 lines (37 loc) · 2.12 KB

Contributing to F-MD

Thank you for considering contributing to F-MD, a simple Fortran implementation of molecular dynamics. We welcome all contributions and appreciate your effort in making this project better!

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

Getting Started

To get the project up and running, please follow the instructions detailed in the README.md file.

Dependencies

Ensure you have the following dependencies installed:

  • Fortran compiler
  • Python 3
  • NumPy
  • Matplotlib

Contributing Guidelines

What We’re Looking For

We welcome a variety of contributions, including:

  • Bug fixes
  • New features
  • Documentation improvements

Coding Standards

  • For Python code, please use the Black linter to format your code. This ensures consistency and readability across the codebase.

How to Contribute

  1. Fork the Repository: Create a fork of the repository to work on your changes.
  2. Create a Branch: Make a new branch for your feature or bugfix.
  3. Explain Your Changes: When starting work on a new feature or bugfix, create an issue or comment on an existing one. Explain:
    • What you plan to implement or correct
    • Why this change is necessary
    • How you plan to implement it

Pull Request Process

  1. Commit Your Changes: Make sure your commits are clear and descriptive.
  2. Create a Pull Request: Submit your pull request against the main branch.
  3. Review: Your code should be reviewed and validated by the repository owner before being merged.

Issue Reporting

  • Reporting Issues: Please report issues or bugs via the Issues tab. Use the provided issue template for consistency.

Communication

For any questions or discussions, please use the GitHub issues for communication.

License

This project is licensed under the terms of the GNU General Public License v3.0. By contributing to this project, you agree that your contributions will be licensed under the same license.