From efc6324a9b0ff04182c5a6683d271c43f33b28d5 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sun, 2 Jul 2017 21:13:29 +0000 Subject: l3build (2jul17) git-svn-id: svn://tug.org/texlive/trunk@44741 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/doc/latex/l3build/CONTRIBUTING.md | 51 +++++++++++++++++++++ Master/texmf-dist/doc/latex/l3build/README.md | 2 +- Master/texmf-dist/doc/latex/l3build/l3build.pdf | Bin 627753 -> 632072 bytes 3 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 Master/texmf-dist/doc/latex/l3build/CONTRIBUTING.md (limited to 'Master/texmf-dist/doc') diff --git a/Master/texmf-dist/doc/latex/l3build/CONTRIBUTING.md b/Master/texmf-dist/doc/latex/l3build/CONTRIBUTING.md new file mode 100644 index 00000000000..67869125e1b --- /dev/null +++ b/Master/texmf-dist/doc/latex/l3build/CONTRIBUTING.md @@ -0,0 +1,51 @@ +Thanks for considering contributing to `l3build`: feedback, fixes and ideas are +all useful. Here, we ([The LaTeX3 Project](https://www.latex-project.org)) have +collected together a few pointers to help things along. + +## Bugs + +Please log bugs using the [issues](https://github.com/latex3/l3build/issues) +system on GitHub, and choose the 'bug' label. Handy information that you might +include, depending on the nature of the issue, includes + +- Your version of `l3build` (`texlua l3build.lua version`) +- Your TeX system details (for example 'TeX Live 2017') +- Your operating system +- The contents of your `build.lua` file +- An 'ASCII art' explanation of your directory layout + +## Feature requests + +Feature requests are welcome: log them in the same way as bugs and pick +the 'Enhancement' label. We welcome feature requests for the test set up, +the build process, _etc._ + +## 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@latex-project.org). + +There are a few things that might look non-standard to most Lua programmers, +which come about as `l3build`'s focus is testing and building LaTeX packages: + +- Our target Lua set up is `texlua` (part of LuaTeX), not standalone `lua` +- The main `l3build.lua` file is self-contained as this helps with + bootstrapping LaTeX: we are aiming to maintain a single file with + `.lua` dependencies +- The primary documentation is aimed at the TeX world, so is in PDF format + and generated from `l3build.dtx` +- As far as possible, everything is done within `l3build` itself or tools + directly available in a TeX system or as standard in the supported + systems (Windows, MacOS, Linux) +- The `l3build` interfaces should be platform-agnostic (though it may be + necessary of course to branch inside particular functions) + +If you are submitting a pull request, notice that + +- We use Travis-CI for (light) testing so add `[ci skip]` to documentation-only + commit messages +- We favour a single linear history so will rebase agreed pull requests on to + the `master` branch +- Where a commit fixes or closes an issue, please include this information + in the first line of the commit message diff --git a/Master/texmf-dist/doc/latex/l3build/README.md b/Master/texmf-dist/doc/latex/l3build/README.md index 39b3e9ce2f5..f96892a628c 100644 --- a/Master/texmf-dist/doc/latex/l3build/README.md +++ b/Master/texmf-dist/doc/latex/l3build/README.md @@ -1,7 +1,7 @@ l3build: a testing and building system for LaTeX3 ================================================= -Release 2017/06/25 +Release 2017/07/01 Overview -------- diff --git a/Master/texmf-dist/doc/latex/l3build/l3build.pdf b/Master/texmf-dist/doc/latex/l3build/l3build.pdf index 2585333cf26..026b6f7e348 100644 Binary files a/Master/texmf-dist/doc/latex/l3build/l3build.pdf and b/Master/texmf-dist/doc/latex/l3build/l3build.pdf differ -- cgit v1.2.3