diff options
| author | Burt P <pburt0@gmail.com> | 2019-09-07 13:00:02 -0500 |
|---|---|---|
| committer | Leandro A. F. Pereira <leandro@hardinfo.org> | 2019-10-24 07:52:52 -0700 |
| commit | b9c1e7359a9b5261a69be7e8f5a177a86f7cd85b (patch) | |
| tree | 44d7ba13f291366029303854baaf6c206f4f49c5 /CONTRIBUTING.md | |
| parent | 6271e173b6fba5560443794cb78f457b2c4fc860 (diff) | |
CONTRIBUTING.md copyedit
Signed-off-by: Burt P <pburt0@gmail.com>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 36 |
1 files changed, 15 insertions, 21 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af5759ef..e62ab5bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,34 +1,28 @@ -Overall info for contribution on source: +# Project -* [Coding contribution] (#coding-contribution) -* [Translations] (#translations) +Issues and Pull Requests via GitHub: -# Coding contribution +* https://github.com/lpereira/hardinfo -All the collaboration work must be using https://github.com/lpereira/hardinfo issues and pull request. -So generally, clone the repository with git, and use branches, before make a pull request. +If this is your first contribution, feel free to add your name to +AUTHORS.md as a commit included in your pull request. ## Pull requests -Please **each and all the pull request must made in related scope**, -this to avoid conflicts, and must avoid massive commits corrections.. -large pulls will take more time from owner to review and commit! - -Pease **each pull request must have descriptive related titles** and -clarelly description in the pull request, about changes in each commits, -and must mantain those amount of commits in blocks and not to be massive. +Pull requests should contain related commits. Each commit should have a +descriptive title, and clearly describe the changes in the commit message. +Please make small commits that are easier to review. ## Coding -Most ancient code use a mixture of TAB and SPACES, but newer must -prefered and priority its to use 4 SPACES! - -# Translations +Ancient code used a mixture of tab and space for indentation, but newer +prefers four (4) spaces for each level of indentation. -We using po files, its recommended before beginning, -try to run `bash updatepo.sh` in the po/ directory to sync files. +# Translators -This will regenerate hardinfo.pot and update all the .po files. Dont worry, -NOTHING IS LOST if this isn't done, but it prevents wasting time translating +If possible, run `bash updatepo.sh` in the po/ directory before begining. +This will regenerate hardinfo.pot and update all the .po files. +Nothing is lost if this isn't done, but it prevents wasting time translating strings that have changed, or are no longer used. +DO NOT use `make pot`! |