Skip to content

Latest commit

 

History

History
116 lines (71 loc) · 4.16 KB

CONTRIBUTING.md

File metadata and controls

116 lines (71 loc) · 4.16 KB
Raw

Contributing to PyFileHandling

Thank you for considering contributing to the PyFileHandling repository! Your contribution is greatly appreciated. This guide will help you understand the process of contributing and how you can get involved.

Getting Started

Prerequisites

To contribute to PyFileHandling, you will need:

  • Python (version 3.12.X)
  • Any additional dependencies specified in the project's requirements.txt or setup.py file

Setting up the Development Environment

  1. Fork the PyFileHandling repository to your GitHub account.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/your-username/PyFileHandling.git

  3. Navigate to the project directory:

    cd PyFileHandling

  4. Install the required dependencies:

    pip install -r requirements.txt

  5. You're ready to make changes!

Contributing

Creating an Issue

If you encounter a bug, have a feature request, or want to suggest an improvement, please consider creating an issue. This allows the project maintainers and community to discuss and address the topic. To create an issue, follow these steps:

  1. Go to the PyFileHandling repository.

  2. Click on the "Issues" tab.

  3. Click on the "New Issue" button.

  4. Provide a descriptive title and a detailed description of the issue.

  5. Click on "Submit new issue".

Creating a Pull Request

If you would like to contribute code to PyFileHandling, you can do so by creating a pull request. This allows your changes to be reviewed and merged into the main repository. To create a pull request, follow these steps:

  1. Commit your changes to a new branch:

    git checkout -b my-new-branch
git commit -am "Add new feature or fix bug"

  2. Push the branch to your forked repository:

    git push origin my-new-branch

  3. Go to the your forked repository on github.

  4. Click on the "Contribute" button.

  5. Open a new pull request from forked repository to master/main repository

  6. Provide a descriptive title and a detailed description of your changes.

  7. Click on "Create pull request".

Style Guidelines

Coding Style

We follow a customized coding style for the PyFileHandling project, which is a blend of our own conventions and some elements from the PEP 8 style guide. The goal is to maintain a codebase that is not only functional but also readable and consistent.

Key Points:

  1. Consistency is Key:

    • While we're not strictly adhering to PEP 8, it's important to maintain consistency in coding style across the project.
    • Consistent styling enhances code readability and makes collaboration smoother.

  2. Clear and Concise Comments:

    • Write comments that explain the purpose of your code. Consider them as notes for your future self and other contributors.
    • Aim for clarity and conciseness in your comments.

  3. Meaningful Naming:

    • Use descriptive variable and function names. A well-named variable is often better than a comment explaining its purpose.
    • Meaningful names contribute to the project's maintainability.

Contribution Guidelines:

  1. Pull Requests:

    • When submitting pull requests, ensure that your code aligns with the established coding style.
    • Mention any deliberate deviations from the style and provide reasons for the changes.

  2. Code Review:

    • Code reviews will consider both functionality and adherence to the coding style.
    • Be open to feedback and discussions about coding style during the review process.

By following these style guidelines, we aim to create a codebase that is not only functional but also accessible and enjoyable for everyone involved.

Code of Conduct

We expect all contributors to follow our Code of Conduct. Please be respectful and considerate towards others when interacting with the community.

License

By contributing to PyFileHandling, you agree that your contributions will be licensed under the MIT License. Make sure you understand and agree with this before submitting your contributions.