Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (38 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

47 lines (38 loc) · 1.7 KB
Raw

Contributing to Star Citizen Stream Deck

Thank you for your interest in contributing to the Star Citizen Stream Deck plugin! Every contribution counts - whether it's bug reports, feature requests, or code changes.

How to Contribute

Reporting Issues

  • Use the GitHub Issues page to report bugs or suggest features.
  • Include as much detail as possible: steps to reproduce, expected behavior, and your environment (OS, Stream Deck software version, etc.).

Submitting Changes

  1. Fork the repository.
  2. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
# or
git checkout -b bugfix/your-bugfix-name
  3. Make your changes following the coding guidelines below.
  4. Write or update unit tests if applicable.
  5. Commit your changes with clear and descriptive messages: 
    git commit -m "Add feature X to improve Y"
  6. Push your branch to your fork: 
    git push origin feature/your-feature-name
  7. Open a Pull Request (PR) against the main branch of this repository.

Pull Request Guidelines: Keep pull requests focused on a single feature, improvement or bug fix. Large or unfocused PRs may be asked to be split or revised.

Coding Guidelines

  • Follow C# best practices.
  • Use meaningful variable and method names.
  • Ensure code is well-commented.
  • Run unit tests before submitting.

Testing

  • Run the existing unit tests to ensure no regressions.
  • Add new tests for new features or bug fixes, if applicable.
  • Ensure tests pass before submitting your PR.

Questions?

If you have any questions, feel free to open an issue or contact me on Discord: chris_nw85