Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 2.05 KB

CONTRIBUTION.MD

File metadata and controls

58 lines (42 loc) · 2.05 KB
Raw

Contributing

Thank you for considering contributing to this project! Here are a few guidelines to help you get started:

How to Contribute

  1. Fork the Repository:

    • Navigate to the project repository and click the "Fork" button in the upper right corner. This creates your own copy of the repository.

  2. Clone Your Fork:

    • Open your terminal and clone your forked repository to your local machine: 
      git clone https://github.com/your-username/project-name.git
cd project-name

  3. Create a Branch:

    • Create a new branch for your feature or bug fix: 
      git checkout -b feature-or-bugfix-name

  4. Make Your Changes:

    • Make your changes to the codebase. Ensure your changes adhere to the project's coding standards.

  5. Test Your Changes:

    • Run any relevant tests to ensure your changes do not break the existing code. Add new tests if necessary.

  6. Commit Your Changes:

    • Commit your changes with a descriptive commit message: 
      git commit -m "Description of the feature or fix"

  7. Push to Your Fork:

    • Push your branch to your forked repository: 
      git push origin feature-or-bugfix-name

  8. Submit a Pull Request:

    • Navigate to the original repository and create a pull request from your fork. Provide a clear and detailed description of your changes and any related issue numbers.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue on the repository. Provide as much detail as possible to help us understand and address the issue.

Additional Notes

  • Dependencies Installation: Follow the instructions in the main README to install necessary dependencies.
  • Data Scraping Instructions: Ensure you follow the guidelines for scraping data responsibly to avoid getting banned from the source website.
  • Data Management: Clear data manually by navigating to the samples/ directory and deleting unwanted files.

Thank you for your contributions!