Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (63 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

93 lines (63 loc) · 2.81 KB

Contributing to ExperQuick

We love that you're interested in contributing to ExperQuick! We welcome all types of contributions from developers, scientists, and researchers.

Ways You Can Contribute:

  • Improving Documentation: Help us keep our docs clear and up to date.
  • Building Plugins: Add integrations or new features to enhance functionality.
  • Fixing Bugs: Report or fix issues in the codebase.
  • Writing Tests: Ensure our code remains robust and reliable.
  • Sharing Your Workflows: Share reproducible experiments and examples in the repository.
  • Participating in Discussions: Join discussions on new features, ideas, or improvements.

Pull Request

What does this PR do? A brief description of the changes made in this pull request.

Related Issue Link to the issue this PR resolves (if applicable).

Additional Notes Any important information reviewers should know (e.g., testing notes, breaking changes).

Testing Instructions How to test your changes locally.

Checklist

  • My code follows the project’s coding style and conventions.
  • I have run tests and verified they pass.
  • I have written documentation for new functionality (if applicable).
  • I have updated the changelog (if applicable).

How to Get Started:

  1. Fork the repository.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your feature or bug fix.
  4. Make your changes. Remember to follow the coding standards and document your code.
  5. Commit your changes and push to your fork.
  6. Open a pull request with a clear description of your changes.

Bug Report

Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Expected behavior A clear and concise description of what you expected to happen.

Screenshots If applicable, add screenshots to help explain your problem.

Environment (please complete the following information):

  • OS: [e.g., Windows 10, macOS]
  • Python version: [e.g., 3.8]
  • Library version: [e.g., 1.2.3]

Additional context Add any other context about the problem here.

Feature Request

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is, and how the feature would solve it.

Describe the solution you'd like A clear and concise description of what you want to happen.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

Code of Conduct

Please review and follow our Code of Conduct.