Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

74 lines (48 loc) · 3.75 KB

Aniworld_Scraper - Contributing Guidelines

Thank you for considering contributing to Aniworld_Scraper! We appreciate your interest in making our anime/series website scraper even better. Please take a moment to review these guidelines before you start contributing. Following these guidelines will ensure a smooth collaboration and make it easier for others to understand and work on the project.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. Contributing to Aniworld_Scraper
  4. Reporting Bugs
  5. Feature Requests
  6. License

Code of Conduct

Before contributing, please review our Code of Conduct. We expect all contributors to follow the code of conduct while participating in the project.

Getting Started

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine using git clone.
  3. Create a new branch for your changes using git checkout -b your-branch-name.
  4. Make your changes, improvements, or bug fixes.
  5. Test your changes to ensure they work as expected.
  6. Commit your changes with clear and descriptive commit messages.
  7. Push the changes to your forked repository on GitHub.
  8. Open a pull request to the main branch of the original repository.

Contributing to Aniworld_Scraper

Creating Issues

If you find a bug, have a feature request, or want to suggest an improvement, please create an issue in the GitHub issue tracker. Clearly describe the problem or the proposed enhancement so that others can understand and collaborate.

Working on Issues

If you are interested in working on an open issue, please comment on the issue to express your intention to work on it. This helps avoid duplication of efforts and informs other contributors about ongoing work.

Pull Requests

We welcome pull requests from contributors. Before submitting a pull request:

  1. Ensure your changes are consistent with the project's scope and goals.
  2. Include tests for any new functionality you introduce.
  3. Write a clear and concise description of your changes in the pull request.

Coding Guidelines

To maintain consistency and readability of the codebase, please adhere to the following coding guidelines:

  1. Use meaningful variable and function names.
  2. Follow PEP 8 guidelines for Python code.
  3. Comment your code wherever necessary, especially in complex or less intuitive sections.
  4. Ensure your code passes any existing unit tests and doesn't introduce new failures.

Reporting Bugs

If you encounter a bug or unexpected behavior while using Aniworld_Scraper, please report it in the GitHub issue tracker with clear steps to reproduce the issue. Attach any relevant logs or error messages that can help identify the problem.

Feature Requests

If you have an idea for a new feature or enhancement, feel free to create an issue in the GitHub issue tracker explaining your proposal and how it would benefit the project.

License

By contributing to Aniworld_Scraper, you agree that your contributions will be licensed under the LICENSE of the project.

Thank you for contributing to Aniworld_Scraper! Your contributions help make the anime/series website scraping experience even more delightful for our users. Happy coding! 🎉