Recommend this page to a friend! |
Classes of milenmk | Simple PHP Password Manager | CONTRIBUTING.md | Download |
|
DownloadHow to contributeBug reports and feature requestsIssues are managed on GitHub. Default language is english. So please prepare your contributions in english.
<a name="code"></a>CodeBasic workflow
<span id="branches" name="branches"></span> BranchesAll pull requests should be made against the develop branch. General rulesPlease don't edit the ChangeLog file. <a name="commits"></a>CommitsUse clear commit messages with the following structure:
where KeywordIn uppercase. The keyword can be omitted if your commit does not fit in any of the following categories:
Issue numberIf your commit fixes a referenced bug or feature request. In the form of a # followed by the GitHub issue number. DescA short description of the commit content. This should ideally be less than 50 characters. LongDescA long description of the commit content. You can really go to town here and explain in depth what you've been doing. Feel free to express technical details, use cases or anything relevant to the current commit. This section can span multiple lines. Try to keep lines under 120 characters. Examples<pre> FIX|Fix #456 Short description (where #456 is number of bug fix, if it exists.) or NEW|New Short description (Use this if you add a feature not tracked, otherwise use CLOSE #456) or CLOSE|Close #456 Short description (where #456 is number of feature request, if it exists.) or Short description (when the commit is not introducing feature nor closing a bug) Long description (Can span across multiple lines). </pre> Pull RequestsPull Request (PR) process is the process to submit a change (enhancement, bug fix, ...) into the code of the project. There is some rules to know and a process to follow to optimize the chance to have PRs merged efficiently...
Also, some code changes need a prior approbation:
Once a PR has been submitted, you may need to wait for its integration. It is common that the project leader let the PR open for a long delay to allow every developer discuss about the PR (A label is added in such a case). If the label of PR start with "Draft" or "WIP" (Work In Progress), it will not be analyzed for merging until you change the label of the PR (but it can be analyzed for discussion). If the PR is kept open for a long time, a tag will also be added on the PR to describe the status of your PR and why the PR is kept open. By putting your mouse on the tag, you will get a full explanation of the tag/status that explain why your PR has not been integrated yet. TranslationsThe source language (en_US) is maintained in the repository. |