Skip to content

Latest commit

 

History

History
51 lines (29 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

51 lines (29 loc) · 1.92 KB
Raw

Contributing to Streamadmin

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Streamadmin, which is hosted here on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Bugs

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. create an issue and provide the following information by filling in the template

Suggesting Enhancements

are submitted like but reports just a changed template.

Your First Code Contribution

Unsure where to begin contributing to Streamadmin? You can start by looking through these beginner and help-wanted issues:

  • [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two.
  • [Help wanted issues][help-wanted] - issues which should be a bit more involved than beginner issues.

Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.

Local development

Streamadmin for local dev we suggest for windows

Xammp, php 8.2, MYSQL, VScode with "PHP Intelephense" and "PHP Sniffer"

Pull Requests

Ready to make a change great, just make sure you only change what is required for the one issue, no large changes will be accepted due to the time it takes to review the code.

first fork the project and create a new branch. the branch should be named on what your trying todo examples:

  • bug-fix-issue-55
  • feature-issue-81

after you have commited the changes and run the tests localy then you are ready to create your pull request