Skip to content

Contributing to GameFlow Connect

Thank you for your interest in contributing to GameFlow Connect! Contributions are what make this project thrive, and we’re excited to have you join us.

How to Contribute

1. Report Issues

If you encounter bugs or have ideas for improvements, you can:

  • Open an issue in the GitHub repository.
  • Provide as much detail as possible, including steps to reproduce bugs or a clear description of your idea.

2. Suggest Enhancements

We’re always open to new ideas. Share your suggestions by creating a Feature Request Issue.

3. Submit Code Changes

Follow these steps to contribute code:

  1. Fork the Repository: Click the "Fork" button on the repository page.
  2. Clone Your Fork: 
    git clone https://github.com/your-username/python-gameflowconnect.git
  3. Create a Branch: 
    git checkout -b your-feature-branch
  4. Make Your Changes: Write clean, well-documented code.
  5. Test Your Changes: Ensure everything works as expected.
  6. Commit and Push: 
    git add .
git commit -m "Add your descriptive commit message"
git push origin your-feature-branch
  7. Open a Pull Request: Go to the repository’s Pull Request section and submit your PR.
Git Semmantic Messages

Use better messages to comunicate what you've done. Here some details about commit messages.

4. Help with Documentation

If you spot missing or unclear information in the documentation, feel free to:

  • Edit existing markdown files.
  • Submit pull requests with your documentation improvements.

Guidelines

  • Be Respectful: GameFlow Connect is a collaborative project. Please maintain a positive and respectful tone in all communications.
  • Follow the Code Style: Keep your code consistent with the existing style. Use comments where necessary.
  • Keep Changes Focused: Make sure your PR is focused on a single issue or feature to simplify reviews.

Resources

We’re thrilled to have you contribute to GameFlow Connect. Let’s build something amazing together!