First off, thanks for taking the time to contribute!
The following is a set of guidelines for contributing to diffbot-kg, which is hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This section guides you through submitting a bug report for diffbot-kg. Following these guidelines helps the maintainer and the community understand your report, reproduce the behavior, and find related reports.
- Use a clear and descriptive title for the issue to identify the problem.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and/or animated GIFs which help demonstrate the steps or point out the part of Indeed Job Scraper which the suggestion is related to.
Please follow these steps to have your contribution considered by the maintainer:
- After you submit your pull request, verify that all status checks are passing.
- While the maintainer reviews your PR, you can also ask for specific people to review your changes.
- Once your pull request is created, it will be reviewed by the maintainer of the project. You may be asked to make changes to your pull request. There's always a chance your pull request won't be accepted.
- All Python must adhere to PEP 8.
- Use type annotations according to PEP 484 and PEP 526.
- Format and lint your python code with Ruff.
- Include docstrings and comments where appropriate.
- Write tests for new features and bug fixes.
This Contributing guide is adapted from the Contributing to Atom guide.