diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/lni/CONTRIBUTING.md')
-rw-r--r-- | Master/texmf-dist/doc/latex/lni/CONTRIBUTING.md | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/Master/texmf-dist/doc/latex/lni/CONTRIBUTING.md b/Master/texmf-dist/doc/latex/lni/CONTRIBUTING.md index 949efa6f696..ff718c5bd63 100644 --- a/Master/texmf-dist/doc/latex/lni/CONTRIBUTING.md +++ b/Master/texmf-dist/doc/latex/lni/CONTRIBUTING.md @@ -1,30 +1,30 @@ # Contributing -We love pull requests from everyone. Contributing is easy: +You can report bugs and request features using the [issues page](https://github.com/gi-ev/lni/issues). -* You can report bugs and request features using the [issues page][issues]. +We love code contributions. +You can easily work on the code if you have a GitHub account ([get one](https://github.com/join)). +For that, please [fork the repository](https://help.github.com/articles/fork-a-repo/), work on the code, and submit a [pull request](https://help.github.com/articles/about-pull-requests/). -[issues]: https://github.com/gi-ev/lni/issues +Take a look at GitHub's excellent overview on the [GitHub flow](https://guides.github.com/introduction/flow/index.html). +The [Feature Branch Workflow](https://de.atlassian.com/git/tutorials/comparing-workflows#feature-branch-workflow) forms the basis of this kind of development. -* You can easily work on the code if you have a GitHub account ([get one][github]): +In other words: -[github]: https://github.com/join +1. Fork the project +2. Clone the repo: -Fork the project, then clone the repo: + git clone git@github.com:your-username/LNI.git - git clone git@github.com:your-username/LNI.git +3. Create a new branch `patch` (or another speaking name) -Make your change(s). + git checkout -b patch -Push to your fork and [submit a pull request][pr]. - -[pr]: https://github.com/gi-ev/lni/compare/ - -At this point you're waiting on us. We like to at least comment on pull requests -as soon as possible. We may suggest some changes or improvements or alternatives. - -Some things that will increase the chance that your pull request is accepted: - -* Write a [good commit message][commit]. - -[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
\ No newline at end of file +3. Make your changes. +4. Commit your changes. + Thereby, try to write a [good commit message](https://github.com/joelparkerhenderson/git_commit_message). +5. Push your chaneges (to your repository) +6. [submit a pull request](https://github.com/gi-ev/lni/compare/) +7. At this point you're waiting on us. + We like to at least comment on pull requests as soon as possible. + We may suggest some changes or improvements or alternatives. |