Skip to content

Latest commit

 

History

History
91 lines (61 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

91 lines (61 loc) · 3.36 KB
Raw

We welcome contributions to SmartGraph! Whether you're fixing bugs, improving documentation, or creating new examples, your help is appreciated. This guide will help you get started with contributing to the project.

Ways to Contribute

There are several ways you can contribute to SmartGraph:

  1. Submitting examples
  2. Reporting bugs
  3. Suggesting enhancements
  4. Improving documentation
  5. Contributing code

Submitting Examples

We love seeing how people use SmartGraph in real-world scenarios. To submit an example:

  1. Fork the SmartGraph repository.
  2. Create a new file in the examples directory with a descriptive name.
  3. Write your example, including a clear description and code snippets.
  4. Submit a pull request with your new example.

Make sure your example is well-documented and follows our code style guidelines.

Reporting Bugs

If you encounter a bug in SmartGraph:

  1. Check the GitHub Issues to see if it has already been reported.
  2. If not, create a new issue, providing as much detail as possible, including:
    • Steps to reproduce the bug
    • Expected behavior
    • Actual behavior
    • SmartGraph version
    • Python version
    • Operating system

Suggesting Enhancements

Have an idea for a new feature or improvement? We'd love to hear it!

  1. Check the GitHub Issues to see if it has already been suggested.
  2. If not, create a new issue, clearly describing your suggested enhancement and its potential benefits.

Improving Documentation

Clear and comprehensive documentation is crucial. To contribute to the docs:

  1. Fork the repository.
  2. Make your changes to the relevant Markdown files in the docs directory.
  3. Submit a pull request with your changes.

Contributing Code

To contribute code to SmartGraph:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Write your code, following our code style guidelines.
  4. Write tests for your code.
  5. Ensure all tests pass by running pytest.
  6. Submit a pull request with your changes.

Code Style Guidelines

  • Follow PEP 8 style guide for Python code.
  • Use type hints where appropriate.
  • Write clear, descriptive commit messages.
  • Include docstrings for all functions, classes, and modules.
  • Keep lines to a maximum of 100 characters.

Pull Request Process

  1. Ensure your code adheres to the style guidelines.
  2. Update the README.md or documentation with details of changes, if applicable.
  3. Add tests for new features or bug fixes.
  4. Ensure the test suite passes.
  5. Your pull request will be reviewed by the maintainers, who may request changes or provide feedback.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Licensing

By contributing to SmartGraph, you agree that your contributions will be licensed under the project's MIT License.

Questions?

If you have any questions about contributing, feel free to ask in the GitHub Discussions or reach out to the maintainers directly.

Thank you for contributing to SmartGraph! Your efforts help make this project better for everyone.