Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 1.57 KB
Raw

Contributing to g2g

First off, thank you for considering contributing to g2g! It's people like you that make g2g such a great tool.

Code of Conduct

This project and everyone participating in it are governed by the g2g Code of Conduct. By participating, you are expected to uphold this code.

Reporting Bugs or Feature Requests

  • Open a new issue here.
  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • Be as detailed as possible.

How Can I Contribute?

Reporting Bugs

Follow the guidelines mentioned above.

Suggesting Enhancements

If you have a neat idea for a feature, open an issue here and we'll look into it.

Pull Requests

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your machine.
  3. Create a new branch for each feature or improvement.
  4. Run the tests to ensure no regression.
  5. Commit changes to git.
  6. Push your changes back to your fork on GitHub.
  7. Create a pull request, adhering to the pull request template by filling in the details.
  8. Submit your pull request.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").

Python Style Guide

This project follows PEP 8 guidelines. Please ensure your code is compliant before submitting a pull request.

Acknowledgments

Your contribution is very much appreciated. Thank you for helping improve g2g!