[latex3-commits] [latex3/latex2e] develop: Update CONTRIBUTING.md [ci skip] (1ae0fd61)
github at latex-project.org
github at latex-project.org
Mon Jan 22 18:00:45 CET 2024
Repository : https://github.com/latex3/latex2e
On branch : develop
Link : https://github.com/latex3/latex2e/commit/1ae0fd615e15e2062c8e7f08058578ca8fb752b7
>---------------------------------------------------------------
commit 1ae0fd615e15e2062c8e7f08058578ca8fb752b7
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date: Mon Jan 22 17:00:45 2024 +0000
Update CONTRIBUTING.md [ci skip]
>---------------------------------------------------------------
1ae0fd615e15e2062c8e7f08058578ca8fb752b7
CONTRIBUTING.md | 30 ++++++++++++++++++++----------
1 file changed, 20 insertions(+), 10 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3582f938..d2862dab 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -75,10 +75,6 @@ regard to this policy.
## Code contributions
-If you want to discuss a possible contribution before (or instead of)
-making a pull request, drop a line to
-[the team](mailto:latex-team at latex-project.org).
-
The stability of LaTeX is very important and this means that change in
the kernel is necessarily very conservative. It also means that a lot of
discussion happens before any changes are made. If you do decide to post
@@ -87,10 +83,24 @@ cannot always integrate them into the kernel.
If you are submitting a pull request, notice that
-- The first line of commit messages should be a short summary (up to about
- 50 chars); leave a blank line then give more detail if required
-- We use Travis-CI for (light) testing so add `[ci skip]` to documentation-only
- commit messages
+- The first line of commit messages should be a short summary (up to about 50
+ chars); leave a blank line then give more detail if required
+- We use GitHub Actions for testing; you can run the test suite locally using
+ `l3build`
- We favour a single linear history so will rebase accepted pull requests
-- Where a commit fixes or closes an issue, please include this information
- in the first line of the commit message [`(fixes #X)` or similar]
+- Where a commit fixes or closes an issue, please include this information in
+ the first line of the commit message [`(fixes #X)` or similar]
+- There is a checklist in the [pull request
+ template](.github/pull_request_template.md) for the various bit of admin that
+ are needed: the key points are
+ - Almost all changes should be listed in the relevant `changes.txt` file
+ - The date in the `\ProvidesPackage` (or similar) line should be updated
+ whenever the file changes
+ - The version in the `\ProvidesPackage` (or similar) should be incremented
+ whenever the code changes
+ - The LaTeX sources include `\changes` that are typeset
+ - Almost always, a code change should be accompanied by a matching test file
+ - More significant changes will need an entry in _LaTeX News_
+- Pull requests that are intended for the next major release of LaTeX should be
+ made against `develop`; if you feel the change is urgent and requires a patch
+ level, the pull request should be made against `main`
\ No newline at end of file
More information about the latex3-commits
mailing list.