From 6271e173b6fba5560443794cb78f457b2c4fc860 Mon Sep 17 00:00:00 2001 From: PICCORO Lenz McKAY Date: Wed, 19 Jul 2017 11:28:34 -0400 Subject: Contributors files firs overall a starter contributors file permits more coders to send pulls and can aprove more quickly avoid waste time in reviews sync and update translation adn already commited CONTRIBUTION FILE without formating * added minimal instruction for translation * added basic intruction for contribution code * added basic rules to coordinate work * use markdown format and added .md extension to automatic formating typo fixeds for right spell as reviewed, redue the files, organize: * mixture of TAB and SPACES, but with priority to use SPACES! * remove the extra info for coding * corrected the very basic english * reduced too much unnecessary exposition. only cited the git minimal * removed API documentation to use a HACK file in future or in docs elsewhere i put some api info due we do not have the hlp/doc info complete, due my think was made a future pull with improvements only to docs directory.. to mantain organization in work and i now reduce the rules/settings to only related to how to code minimal, and let the API citation only until we have priority 4 espaces but not hard rule as discuted in 102#issuecomment-316764510 (#102) rules about pull request, due hard to review thems rules about pull request, due amount of mixed and unrelated changes hard to review --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++---------- 1 file changed, 28 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0b82439a..af5759ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,34 @@ -Project -======= +Overall info for contribution on source: -Issues and Pull Requests via GitHub: +* [Coding contribution] (#coding-contribution) +* [Translations] (#translations) -* https://github.com/lpereira/hardinfo +# Coding contribution -Translators -=========== +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 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 +## 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. + +## Coding + +Most ancient code use a mixture of TAB and SPACES, but newer must +prefered and priority its to use 4 SPACES! + +# Translations + +We using po files, its recommended before beginning, +try to run `bash updatepo.sh` in the po/ directory to sync files. + +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 strings that have changed, or are no longer used. -DO NOT use `make pot`! -- cgit v1.2.3