Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (39 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

51 lines (39 loc) · 1.64 KB

Contribution Guidelines

Thank you for considering contributing to this project! We welcome contributions from everyone. By participating in this project, you agree to abide by our code of conduct.

How to Contribute

1. Fork the Repository

Create a fork of this repository by clicking the "Fork" button at the top right of this page. This will create a copy of the repository under your GitHub account.

2. Clone Your Fork

Clone your forked repository to your local machine:

git clone https://github.com/ParmarDarshan29/NeuroML-PTSD.git

3. Create a New Branch

Create a new branch for your feature or bug fix:

git checkout -b feature/your-feature-name

4. Make Changes

Make your changes to the codebase. Ensure that your code adheres to the project's coding standards.

5. Test Your Changes

Run the tests to ensure that your changes do not break existing functionality:

pytest

6. Commit Your Changes

Commit your changes with a descriptive commit message:

git add .
git commit -m "Add a descriptive commit message"

7. Push Your Changes

Push your changes to your forked repository:

git push origin feature/your-feature-name

8. Open a Pull Request

Open a pull request from your branch to the main branch of this repository. Provide a clear description of your changes and any relevant context.

Code of Conduct

Please read and follow our Code of Conduct.

Reporting Issues

If you encounter any issues, please open an issue in the repository. Provide as much detail as possible, including steps to reproduce the issue and any relevant logs or screenshots.