Git-Mirrors/Qubes-Community-Content
1
0
Fork 0
mirror of https://github.com/Qubes-Community/Contents.git synced 2024-12-22 13:55:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update no-git-submissions.md

Browse Source
This commit is contained in:
Ivan 2018-03-14 19:23:24 +00:00 committed by GitHub
parent b45d10f36d
commit c398d6d6ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/no-git-submissions.md
View File

@ -1,9 +1,15 @@
#### Contributing without knowing git
A shortcoming of the official [qubes-doc](https://www.qubes-os.org/doc/) is that basic git knowledge is [required](https://www.qubes-os.org/doc/doc-guidelines/) to contribute: while git command line isn't necessary, concepts like forking a repository or understanding pull requests have to be mastered, as well as synchronizing a forked repository with the official repository for subsequent contributions.
Contributing to the official Qubes OS [documentation](https://www.qubes-os.org/doc/) requires contributors to understand git concepts like forking a repository, submitting pull requests and keeping a forked repository synchronized with upstream. Some of those concepts are easy to master, others are more involved.
Qubes users who don't want to learn git for a reason or another or who don't feel confident submitting a pull request (PR) can simply create an issue in this github community page ("Issues" tab above), with any content they see fit: addition or improvements to documentation, suggestions, tips, typo fixes, one-liners, ...
Qubes users who don't want to learn git for a reason or another - or who don't feel confident submitting a pull request (PR) - can simply create an issue in this github community page in the "Issues" tab above with any content they see fit: addition or improvements to documentation, suggestions, tips, typo fixes, one-liners, ...
After (optional) discussion in the issue's thread and if the content is deemed fit for submission (whether to this project's unoffical documentation or to Qubes' official qubes-doc repository) a community member may either create a git pull request on your behalf and take care of anything "git", or if you'd like to, he could guide you in creating your own PR. Note however that in the former case attribution/credit cannot be assigned to you - it is a technical shortcoming of having a pull request created and submitted on your behalf.
After (optional) discussion in the issue's thread and if the content is deemed fit for submission (whether to this project's unoffical documentation repository or to Qubes' official qubes-doc repository) a community member will create a git pull request on your behalf and take care of anything "git", or alternatively he will guide you in creating your own PR - if you'd like to of course. Note however that in the former case you'll loose attribution/credit because github doesn't allow transferring a pull request's ownership.
It would of course ease the burden on community members if returning contributors learn the few basic git steps required to submit pull requests themselves, but this is of course not a requirement.
#### Learning git for further contributions
It would of course ease the burden on community members if returning contributors learn the few basic git concepts required to submit pull requests themselves, but this is of course not a requirement.
The official Qubes OS documentation [contribution guidelines](https://www.qubes-os.org/doc/doc-guidelines/) is a good start. It is based on contributing to the official qubes-doc repository but is applicable to any other project.
However the guide doesn't approach the problem of keeping a forked repository synchronized with "upstream" (eg. the official repository). This isn't a trivial problem ([github help page]](https://help.github.com/articles/syncing-a-fork/)), especially when you have made changes in your forked repository ([stackoverflow post](https://stackoverflow.com/questions/7244321/how-do-i-update-a-github-forked-repository)). So until you are proficient enough to understand the steps involved, a simple alternative that does not require command line usage is to delete the forked repository and re-fork it from upstream. This is a bit of a "nuclear" option though and you'll obviously loose any changes you've made in your forked repository.