Add contributing guide

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+## Contributing to Diffbot Knowledge Graph Client
+
+First off, thanks for taking the time to contribute!
+
+The following is a set of guidelines for contributing to `diffbot-kg-client`, 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.
+
+### How Can I Contribute?
+
+#### Reporting Bugs
+
+This section guides you through submitting a bug report for `diffbot-kg-client`. 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.
+
+#### Pull Requests
+
+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.
+
+#### Python Styleguide
+
+- All Python must adhere to [PEP 8](https://www.python.org/dev/peps/pep-0008/).
+- Use type annotations according to [PEP 484](https://www.python.org/dev/peps/pep-0484/) and [PEP 526](https://www.python.org/dev/peps/pep-0526/).
+- Format your python code with [Black](https://github.com/ambv/black).
+- Lint your python code with [Ruff](https://github.com/jendrikseipp/ruff).
+- Include docstrings and comments where appropriate.
+- Write tests for new features and bug fixes.
+
+To automatically format and lint your code on commit, run `pre-commit install` in the root of the repository.
+
+### Attribution
+
+This Contributing guide is adapted from the [Contributing to Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md) guide.

README.md

@@ -34,7 +34,7 @@ enhanced_entity = enhance_client.enhance({query='type:Organization name:Diffbot'
 Contributing
 ------------
 
-Contributions to this project are welcome.
+Contributions to this project are welcome. - see the CONTRIBUTING.md file for details.
 
 License
 -------