Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

67 lines (49 loc) · 3 KB

Contributing to Directory Cleaner

First off, thank you for considering contributing to the Directory Cleaner project! Whether it's fixing a bug, adding a feature, or helping to improve the documentation, we welcome your involvement and appreciate your effort.

How to Contribute

We encourage contributions from everyone! If you’d like to contribute to this project, here’s how you can get started:

1. Fork the Repository

To start contributing, fork the repository and create your own branch for the change you want to make. This will ensure you can work on your contribution without affecting the main codebase.

2. Set Up Your Local Environment

Clone your forked repository to your local machine:

git clone https://github.com/your-username/directory-cleaner.git
cd directory-cleaner

Install any dependencies needed for the project (add any requirements in the requirements.txt file if needed):

pip install -r requirements.txt

3. Make Your Changes

  • Choose an area of the project you’d like to contribute to.
  • Add a feature, fix a bug, or improve the documentation.
  • Make sure to follow the existing code style and formatting.

4. Write Tests (if applicable)

If your changes involve new features or bug fixes, please write corresponding tests to ensure everything works as expected. Add your tests in the relevant test files.

5. Commit Your Changes

Once you’ve made your changes and are ready to submit them, commit your work with a meaningful commit message.

git add .
git commit -m "Description of what you've done"

6. Push to Your Fork

Push your changes to your forked repository on GitHub:

git push origin your-branch-name

7. Create a Pull Request

Now that your changes are pushed, you can open a Pull Request (PR) from your forked repository to the main repository. In the PR description, make sure to explain:

  • What the change does
  • Why you made the change
  • Any testing that was done

8. Follow Code of Conduct

When contributing, please be respectful and follow our Code of Conduct. Be kind, inclusive, and open to feedback!

Pull Request Process

  1. Ensure your changes are aligned with the project’s goals: We want to keep the project clean, simple, and effective.
  2. Tests: Make sure all new code is covered by tests, and that the existing tests pass.
  3. Review: After opening your pull request, our maintainers will review your code. They might provide feedback, and you may need to make adjustments before the PR can be merged.
  4. Merging: Once the pull request is approved, it will be merged into the main branch. You’ll receive credit for your contribution!

Documentation

If you’re adding new features or changing existing functionality, please update the documentation accordingly. It helps the next person who works on the project!

Questions?

If you have any questions or need help getting started, feel free to open an issue or reach out to the project maintainers. We’re happy to assist you!