Skip to content

Latest commit

 

History

History
85 lines (67 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

85 lines (67 loc) · 2.96 KB
Raw

Contributing to mbox-to-json

Thank you for considering contributing to mbox-to-json! Contributions are welcome and appreciated. Here are some guidelines to help you get started.

Table of Contents

How to Contribute

Reporting Bugs

If you've found a bug, please open an issue in the Issues section. Include as much detail as possible to help us reproduce the problem:

  • Describe the bug clearly.
  • Provide steps to reproduce the issue.
  • Share your environment details (OS, Python version, mbox-to-json version).
  • Include any relevant error messages or screenshots.

Suggesting Features

We welcome feature suggestions! If you have an idea to improve the project, please open an issue labeled as a "Feature Request" with:

  • A clear description of the feature.
  • Explanation of why it would be beneficial.
  • Any ideas for how the feature could be implemented.

Submitting Pull Requests

We encourage you to contribute by submitting pull requests. Please ensure:

  1. Fork the repository and create a branch for your feature or fix.
  2. Write clear and concise code that follows the project’s coding style.
  3. Add tests if your changes include new functionality.
  4. Test your code to confirm it works as expected.
  5. Update the documentation if you change existing behavior or add new features.

To submit a pull request:

  1. Create your pull request from your branch to the main branch in this repository.
  2. In the pull request description, include:
    • A summary of the changes.
    • The issue(s) it addresses, if applicable.
  3. Ensure your code passes all tests and checks.

Setting Up the Development Environment

  1. Clone the repository: 
    git clone https://github.com/YOUR_USERNAME/mbox-to-json.git
cd mbox-to-json
  2. Install dependencies:
    We recommend using a virtual environment: 
    python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Running Test

To ensure everything is working as expected, run the test suite:

pytest

Code Style

  • Follow PEP 8 guidelines for Python code.
  • Use descriptive variable names and comments where needed.

Documentation

  • If your contribution changes any functionality, please update the relevant documentation (e.g., README.md).
  • Document new functions or classes in the code using docstrings.

Code of Conduct

Please be respectful and considerate in your interactions with other contributors. Follow the Code of Conduct.

Thank you for helping improve mbox-to-json!