Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 3.69 KB

CONTRIBUTING.md

File metadata and controls

54 lines (39 loc) · 3.69 KB
Raw

This repository respects people, despite their race, gender, religion, height or culture. Any user who posts offensive or disrespectful content regarding race, gender, religion, height or culture will be immediately banned from this repository. No exception will be made.

DO NOT publish garbage PRs to farm Crypto AirDrops. Any user suspected of this action will get banned. Submitting broken code wastes the time of the contributors, who have to spend their free time reviewing, fixing, and testing code that does not even compile, does not break other functionality, or does not introduce any changes at all.

Contributing guidelines:

Before reading: All of the rules below are guidelines, which means that they should be followed when possible. Please do not take them literally.

Discussions:

  • This is the place to post any questions/doubts regarding WingetUI. Issues and feature requests should be posted in the issues section.

Issues and feature requests:

Issues:

  • Please use the BUG/ISSUE template
  • Please be clear when describing issues.
  • Please fill out the form and DO NOT send empty issues with the information on the title.
  • Please make sure to check for duplicates as said in the BUG/ISSUE template.
  • Please make sure to preceed titles with the [BUG/ISSUE] string, so they can be easily identified.

Feature requests:

  • Please use the FEATURE REQUEST template
  • Please detail how the feature should work. Please be as specific as possible.
  • Some features are difficult and might take some time to get implemented. This project is made in the contributor's free time, so please do not post messages asking for ETAs or similar. Every feature request will be considered.
  • Please make sure to check for duplicates as said in the FEATURE REQUEST template.
  • Please make sure to preceed titles with the [FEATURE REQUEST] string, so they can be easily identified.

Pull requests:

  • Please specify, either in the title or in the PR body text, the changes done.
  • Improvements pull request should have a list of the changes done in the body message, whether they are listed in the commits or not.
  • Draft pull requests should be properly identified as draft pull requests to avoid confusion.
  • When modifying/coding, please follow the guidelines below:

Coding:

  • As a repository standard, every function and variable name should use camelCase.
    • Correct usage: updatesCount = 0, def searchForUpdates(packageManager):
    • Incorrect usage: updates_count = 0, def searchforupdates(package_manager):
  • Constants should be written in capital letters, using underscores for spaces:
    • Example: SYSTEM_DEFAULT_LOCALE = "ca-ES"
  • Please specify, when possible, variable data types and function return types. More info here
  • Try to add spaces and empty newlines to make code more human-readable.

Commits:

  • Commits must include only changes on one feature or section of the code. Let's say, you have fixed an issue regarding localization and added a new entry in the settings section to change update frequency, those two changes must be committed separately.
  • The code in each commit should be executable. Please do not leave work unfinished across commits, or, if it is needed, let the code be executed without errors.
  • Commit names must be self-explanatory, and, if applicable, must reference the corresponding issue.