Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (33 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

43 lines (33 loc) · 1.93 KB

Contributing to MISPR

Welcome to MISPR! We're excited to have you contribute to our project. Before you get started, please take a moment to review the guidelines below.

How to Contribute

Reporting Bugs

If you encounter a bug or unexpected behavior, please open a new issue on our GitHub repository. When reporting bugs, please include detailed steps to reproduce the issue, your environment (such as Python version, operating system), and any relevant error messages or logs.

Requesting Features

If you have a feature request or suggestion for MISPR, we'd love to hear it! Please open a new issue on GitHub and describe the feature you'd like to see, along with any context or use cases that might help us understand the request better.

Contributing Code

We welcome contributions to MISPR in the form of code improvements, bug fixes, new features, or documentation enhancements. To contribute code:

  1. Fork the repository and create a new branch for your changes.
  2. Make your changes and ensure that they follow our coding style and guidelines.
  3. Write tests to cover any new functionality or changes.
  4. Run the test suite to ensure that all tests pass.
  5. Submit a pull request (PR) to the main repository with a clear description of your changes and why they're valuable.

Our team will then review your PR, provide feedback if needed, and work with you to merge it into the main codebase.

Code Style and Guidelines

  • Follow PEP 8 style guidelines for Python code.
  • Write clear and descriptive commit messages.
  • Keep code changes focused and avoid unrelated changes in the same PR.
  • Use meaningful variable and function names.
  • Include comments where necessary to explain complex logic or edge cases.

Getting Help

If you have questions, need help, or want to discuss ideas related to MISPR, you can: