Skip to content

Latest commit

 

History

History
105 lines (68 loc) · 4.94 KB

universal-contributing.md

File metadata and controls

105 lines (68 loc) · 4.94 KB

hugoalh Universal Contributing Guide

This document includes the universal guidelines and methods/ways to contribute over all of the hugoalh projects; However, some of the projects may have revises and take precedence over this document.

Tip

How To...

Fix Grammar Mistakes

You can fix grammar mistakes by create pull request; Alternatively, create issue to point out the grammar mistakes.

Fix Misspellings/Typos

You can fix misspellings/typos by create pull request; Alternatively, create issue to point out the misspellings/typos.

Be aware that the spelling differences between the language variants are not count as misspelling/typo, unless language variants are provided and support at the project!

Language Prefer Variant
Arabic (اَلْعَرَبِيَّةُ) United Arab Emirates
Bangla (বাংলা) Bangladesh
Chinese (華語) Traditional / 正體 / 繁體
Dutch (Nederlands) Standard Dutch / The Netherlands
English (English) British / England / United Kingdom (UK)
French (Français) France
German (Deutsch) Standard German / Germany
Italian (Italiano) Standard Italian / Italy
Korean (한국어) Hangul / South Korea
Portuguese (Português) European Portuguese / Portugal
Spanish (Español) Castilian Spanish / Spain
Swedish (Svenska) Standard Swedish / Sweden

Improve Repository Wiki Pages

Unfortunately only maintainers are able to edit the project's repository wiki directly, however you can create issue at the project's repository to point out it's wiki pages that need to improve.

Internationalization (I18n) / Localization / Translation

All of the details are only in the project's Contributing Guide.

You can also request for implementation by create issue.

Report Bugs

To report bugs, please create issue.

Report Security Vulnerabilities

To report security vulnerabilities, please create security vulnerability report.

Request New Features

To request new features, please create issue.

Guideline

Coding

Please visit the "hugoalh Universal Coding Guide" for the details.

Create Discussion

  • Any report or request should create issue instead.
  • Before create discussion, check whether any similar discussions are already exist.
  • Create discussion under the most appropriate/suitable category.

Note

  • Some of the project's repository does not provide discussion system, please create issue instead.

Create Issue

  • Any question should create discussion instead.
  • Any security vulnerability report should create security vulnerability report instead.
  • Before create issue, check whether any similar issues are already exist, even the closed issues.
  • Create issue under the most appropriate/suitable category.

Create Pull Request

  • Before create pull request, check whether any similar pull requests are already exist, even the closed pull requests.
  • Always create pull request to the default branch (mostly named main or master).
  • Try to avoid merge conflicts if possible.
  • Try to avoid pull request with too many changes if possible.
    • A large pull request not only stretches the review time, but also makes it much harder to spot issues.
    • It is better to split the pull request to multiple smaller ones.
  • If the pull request is resolving issues, link those issues in the pull request.
  • If the pull request is not ready but want to save/stage it, mark it as draft and no need to add any identifications to the title (e.g.: [WIP] XXXXXXXX).

Note

  • The pull request does not need to pass any automatic reviews, automatic reviews are the references for the code reviewers.

Create Security Vulnerability Report

To report security vulnerabilities via GitHub, visit the "GitHub Docs - Privately reporting a security vulnerability" for the details and steps.

To report security vulnerabilities via other methods/ways, these are not available currently.

Caution

  • Never report security vulnerabilities publicly, any public security vulnerability report will be rejected and deleted without notice.

Note

  • If the project's GitHub repository have not enabled the Security Advisories system (mostly cause by misconfiguration), please create issue to request enable it.