Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 2.32 KB
Raw

Contributing to PhysAI

We're thrilled that you're interested in contributing to the PhysAI project! This document provides guidelines for contributions to ensure a smooth collaboration process.

How to Contribute

Contributions can come in many forms, from submitting a bug report or feature request in the issues, to updating documentation or writing code. Here’s how you can contribute:

Reporting Bugs or Issues

If you encounter a problem with any of the tools or the website, please submit an issue via the GitHub issue tracker. Please include:

  • A clear and descriptive title.
  • A detailed description of the problem.
  • Steps to reproduce the issue.
  • Expected and actual outcomes.
  • Any additional context or screenshots that might be helpful.

Suggesting Enhancements

We welcome suggestions for improvements or new features. Please submit an enhancement request through the issue tracker with the following information:

  • A clear and descriptive title.
  • A detailed description of the proposed feature or improvement.
  • Explain why this enhancement would be useful to the project.
  • Any additional context, such as examples or mock-ups.

Pull Requests

Ready to contribute code or documentation? Here’s how to submit a good pull request:

  1. Fork the Repository: Start by forking the repository and then cloning it locally to make your changes.
  2. Create a Branch: Create a branch in your fork for your changes. It's best to name the branch something descriptive.
  3. Make Your Changes: Add your changes to the branch, adhering to the coding conventions and documentation style of the project.
  4. Test Your Changes: Make sure your changes do not break the project. Update or add tests as necessary.
  5. Write a Good Commit Message: Include a concise, descriptive commit message. Mention any issues your commit addresses.
  6. Submit a Pull Request: Push your branch to your fork on GitHub and then submit a pull request to the main repository. Provide a descriptive title and a detailed description of your changes.

Code of Conduct

By participating in this project, you agree to abide by its Code of Conduct. Respectful collaboration is crucial to a productive environment.

Questions?

If you have any questions about contributing, please reach out via email or through an issue on GitHub.