Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (39 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

62 lines (39 loc) · 3.08 KB
Raw

Contributing to gh-auto-follow

Thank you for considering contributing to gh-auto-follow! We're excited to have your help in improving this project. Here’s how you can get started:

How to Contribute

There are several ways you can contribute to the gh-auto-follow project:

  • Reporting Bugs: If you find any issues with the script or have an idea for improvement, please open an issue.
  • Improving Documentation: If you think any part of the documentation could be improved or clarified, feel free to submit a pull request.
  • Fixing Bugs: If you know how to fix an issue or have a patch to offer, open a pull request with your proposed changes.
  • Adding Features: If you have ideas for new features or enhancements, please open an issue to discuss them first. Once discussed, feel free to submit a pull request.

Reporting Issues

If you encounter any problems with gh-auto-follow, please:

  1. Check the existing issues to see if your issue has already been reported.
  2. If it hasn’t, open a new issue, providing as much detail as possible (steps to reproduce, error messages, etc.). Be sure to include relevant information such as your Python version and GitHub Actions settings.

Pull Requests

We welcome pull requests! Here are some guidelines to follow when submitting a PR:

  • Fork the repo and clone your fork to your local machine.
  • Create a new branch from the main branch for your changes.
  • Make your changes, ensuring that your code adheres to the existing style and is well-documented.
  • Test your changes locally to ensure that they work as expected.
  • Commit your changes with a clear message explaining what you’ve done.
  • Push to your fork and submit a pull request to the main branch of this repository.

Code Style

  • Follow Python's PEP 8 style guide.
  • Use descriptive variable and function names.
  • Ensure your code is clean and well-commented, especially for complex logic.
  • Ensure that the script maintains compatibility with Python 3.10+.

GitHub Actions

When submitting a pull request, please ensure the GitHub Actions workflows run successfully:

  • The auto-follow.yml workflow should run correctly without errors.
  • Tests should pass (if any tests are provided in the future).

Security

License

By contributing to this repository, you agree that your contributions will be licensed under the MIT License.

Additional Notes

  • If you are working on a particularly large change or new feature, it’s a good idea to open an issue first to discuss it with the project maintainers before spending too much time on development.
  • If you’re unsure about something, feel free to ask questions. We’re here to help!

Thank You!

Thank you for your interest in contributing to gh-auto-follow! Your help makes the open-source community better for everyone.