Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

39 lines (27 loc) · 1.79 KB
Raw

Contributing to muTEG-Simulator

Thank you for your interest in contributing to muTEG-Simulator! We welcome contributions from the community and appreciate any help you can provide. Here’s how you can contribute:

How to Contribute

  1. Fork the Repository: Click the "Fork" button in the top-right corner of the repository page to create a copy of the project in your own GitHub account.
  2. Clone Your Fork: Clone the repository to your local machine.
  3. Create a Branch: Create a new branch for your changes.
  4. Make Changes: Make the necessary changes or improvements in your branch.
  5. Commit Changes: Commit your changes with a descriptive message.
  6. Push to GitHub: Push your changes to your forked repository:
  7. Submit a Pull Request: Go to the original repository and submit a pull request (PR) from your branch.

Guidelines

  • Code Style: Follow the existing code style and guidelines of the project.
  • Testing: Ensure that your changes are tested and do not break existing functionality.
  • Documentation: Update documentation if your changes include modifications to functionality or features.
  • Commit Messages: Write clear, concise commit messages that describe the changes made.

Reporting Issues

If you encounter any issues or bugs, please open an issue in the repository with a detailed description of the problem. To report an issue:

  1. Go to the Issues page of the repository.
  2. Click "New Issue" and fill out the provided template with details about the issue.

Contact

If you have questions or need further assistance, you can contact me directly:

Thank you for contributing and helping to improve the muTEG-Simulator!