Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 2.27 KB
Raw

Welcome to Amazon Product Details Scraper contributing guide

Thank you for investing your time in contributing to our project! We welcome contributions to this project! Here's how you can get involved:

1. Issues:

  • Bug reports: If you encounter a bug, please search existing issues first to avoid duplicates. If you can't find a relevant issue, create a new one with a clear description of the problem, including steps to reproduce it.
  • Feature requests: If you have an idea for a new feature, feel free to create an issue to discuss it. Explain the functionality you'd like to see and how it would benefit the project.

2. Pull Requests:

  • Fork the repository: Create a fork of the repository on GitHub.
  • Clone your fork: Clone your forked repository to your local machine.
  • Create a new branch: Create a new branch for your changes (e.g., feature/your_feature_name).
  • Implement your changes: Make your modifications to the code.
  • Write clear commit messages: Use descriptive commit messages that explain your changes.
  • Test your changes: Ensure your changes don't introduce regressions. Consider adding unit tests if applicable.
  • Push to your branch: Push your changes to your branch on your forked repository.
  • Create a pull request: Create a pull request from your branch to the main branch of the upstream repository.
  • Address feedback: We will review your pull request and provide feedback. Be prepared to address any comments or suggestions.

3. Coding Style:

  • Follow PEP 8 style guide for Python code.
  • Use consistent formatting and indentation.

4. License:

  • This project is licensed under the MIT License. Please ensure your contributions are compatible with the license.

5. Code Documentation:

  • Add comments to document your code, especially complex sections.
  • Consider using docstrings to explain functions and classes.

Thank you for your contributions!

Additional Notes:

  • You are not obligated to include all the sections mentioned above. Adapt them to your project's specific needs.
  • Feel free to add a section about setting up development environment if your project has dependencies.
  • Consider including a code of conduct to promote a positive and inclusive community.