Thank you for your interest in contributing to this project! Here’s how you can get started:
- Check the existing issues to ensure your idea or bug isn’t already being addressed.
- If it’s new, feel free to open an issue or proceed with your contribution.
- Fork the repository.
- Create a new branch for your changes.
- Make your changes.
- Submit a pull request (PR) to the main branch.
Use semantic commit messages to ensure clarity and consistency. Each commit message should follow this format:
<type>: <short description>
<optional detailed description>
- feat: A new feature (e.g.,
feat: add image download functionality). - fix: A bug fix (e.g.,
fix: resolve null pointer error in parser). - docs: Documentation changes (e.g.,
docs: update README for installation). - style: Code style changes that do not affect logic (e.g.,
style: reformat code with black). - chore: Maintenance tasks (e.g.,
chore: update dependencies).
Use a virtual environment to keep dependencies isolated:
git clone https://github.com/sean1832/pinterest-dl.git
pip install -e .- Start Early: Submit your PR even if it’s a work-in-progress (WIP). Include a clear description of your changes and the purpose.
- Document: Add or update documentation if your changes impact the functionality or usage.
- Communicate: Mention any pending items that need resolution before the PR can be merged.
We are committed to fostering a welcoming and inclusive community. Please be respectful and considerate when participating.
Thank you for contributing!