summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/lni/CONTRIBUTING.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2023-11-27 20:40:50 +0000
committerKarl Berry <karl@freefriends.org>2023-11-27 20:40:50 +0000
commitc693f87bb999811033329ceb2eac1da17281ed89 (patch)
tree883aa6dd9603477871d02d9eee5d265cfe53df3e /Master/texmf-dist/doc/latex/lni/CONTRIBUTING.md
parentfd4bf9c8239a7842dc4557378337a32377d51f70 (diff)
lni (27nov23)
git-svn-id: svn://tug.org/texlive/trunk@68984 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/lni/CONTRIBUTING.md')
-rw-r--r--Master/texmf-dist/doc/latex/lni/CONTRIBUTING.md34
1 files changed, 29 insertions, 5 deletions
diff --git a/Master/texmf-dist/doc/latex/lni/CONTRIBUTING.md b/Master/texmf-dist/doc/latex/lni/CONTRIBUTING.md
index ff718c5bd63..0b8e296053c 100644
--- a/Master/texmf-dist/doc/latex/lni/CONTRIBUTING.md
+++ b/Master/texmf-dist/doc/latex/lni/CONTRIBUTING.md
@@ -6,6 +6,30 @@ 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/).
+## LaTeX hints
+
+We base on [reitzig's TeXLive Docker Images](https://github.com/reitzig/texlive-docker), which are small.
+They require each new package listed in `Texlivefile`.
+Thus, if you add a new LaTeX package, please also add it into that file.
+
+You can have a full `bash` environment to experiment by using following command (assuming you are on Windows and checked out the repository at `c:\git-repositories\LNI`):
+
+ docker run -it --rm -v c:\git-repositories\LNI:/work/src reitzig/texlive-base:2023.1 work bash
+
+After `cd /work/src`, you are in the directory hosting `lni.dtx` and all other files.
+
+You can check successful generation of `lni.cls` based on `lni.dtx` using following command:
+
+ docker run --rm -v c:\git-repositories\LNI:/work/src reitzig/texlive-base:2023.1 work
+
+⚠ Running that command overwrites `lni.cls` (based on `lni.dtx`), so be careful. ⚠
+
+## CI checks
+
+We have a GitHub workflow running, which checks the complete build using that Docker image.
+
+## Hints on GitHub usage
+
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.
@@ -20,11 +44,11 @@ In other words:
git checkout -b patch
-3. Make your changes.
-4. Commit your changes.
+4. Make your changes.
+5. 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.
+6. Push your changes (to your repository)
+7. [submit a pull request](https://github.com/gi-ev/lni/compare/)
+8. 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.