diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/lni/CONTRIBUTING.md |
Initial commit
Diffstat (limited to 'macros/latex/contrib/lni/CONTRIBUTING.md')
-rw-r--r-- | macros/latex/contrib/lni/CONTRIBUTING.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/macros/latex/contrib/lni/CONTRIBUTING.md b/macros/latex/contrib/lni/CONTRIBUTING.md new file mode 100644 index 0000000000..ff718c5bd6 --- /dev/null +++ b/macros/latex/contrib/lni/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing + +You can report bugs and request features using the [issues page](https://github.com/gi-ev/lni/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/). + +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. + +In other words: + +1. Fork the project +2. Clone the repo: + + git clone git@github.com:your-username/LNI.git + +3. Create a new branch `patch` (or another speaking name) + + git checkout -b patch + +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. |