Skip to content

Latest commit

 

History

History
22 lines (18 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

22 lines (18 loc) · 2.36 KB
Raw

Contributing to Rise Media Player

Getting started

Before contributing, you might want to check our building instructions, and get familiar with the codebase. This will likely reduce the amount of time spent on getting your contribution checked and/or done.

Contributing guidelines

Contributing anytime is always welcome, but

  1. We recommend you to look at the Issues tab on the repository and check the issues with labels like "triage approved", "help wanted", these are usually possible to do and verified by our team of collaborators. You are also welcome to contribute fixes/features that are not with these labels, but those will have a slightly lower priority than those with the labels.
  2. In the code (XAML or C#), use proper padding, styles as per Microsoft's C# coding conventions. You can use a code formatter if you want :)
  3. If you are developing a new feature or fixing a bug, always check if there's an existing user control, extension method for the function you're looking for before adding a new method, and add it to a helper class if you feel like the code is going to be reused in multiple files.
  4. Be familiar with the Model-View-View-Model (MVVM) pattern, it's used in most parts of the app and makes things easier to maintain in the meantime.
  5. Please keep contributions as open as possible (i.e on a pull request, a fork), failing to do so might result in the resulting contribution being reverted.
  6. Open an issue of your contribution before starting work on it. Your PR might get closed if there is no related issue.

Guidelines for issues

  1. Make sure the issue is reproducible after many attempts, and if the bug persists even after restart.
  2. Label your issue correctly, and don't add labels like "triage approved" and "help wanted" because these are usually handled by the team.
  3. Add screenshots/videos/mockups of your issue so that it becomes clearer.
  4. Properly describe the bug/feature you are talking about, failing to do so for bugs might result in your issue being closed.
  5. Add your Windows version and build number you're currently running RiseMP on, for example: Windows 11 build 22000.318, Windows 10 build 18362.1 etc...
  6. If you are going to work on an issue, comment on it and say that you're going to work on it to prevent duplicated effort.