Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 1.6 KB

Contributing

I love your input! I want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Pull requests

I use github to host code, to track issues and feature requests, as well as accept pull requests. Pull requests are the best way to propose changes to the codebase. I actively welcome your pull requests. You can make a pull request by following these guidelines:

  1. Fork the repo and create your branch from dev. Use following url to fork: https://github.com/mregni/EmbyStat.git
  2. Add your code.
  3. If you've added code that should be tested, add tests.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Code location

  • Frontend code is located in the EmbyStat.Web project.
  • Backend code starts in the EmbyStat.Controllers project.
  • Test project is located in Tests.Unit

Write bug reports

When writing a bug report please follow the bug report template So I can understand the bug immediately without messaging for ages first.

Feature request

I love feature requests. This makes the app better and better every time. So if you have a feature on your mind please fill in the new feature issue template and we will see what is possible.

License

Any contributions you make will be under the MIT Software License. In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project.