[latex3-commits] [l3svn] branch master updated: Add some advice for pull requests

[noreply at latex-project.org]

This is an automated email from the git hooks/post-receive script.

joseph pushed a commit to branch master
in repository l3svn.

The following commit(s) were added to refs/heads/master by this push:
       new  d53e809   Add some advice for pull requests
d53e809 is described below

commit d53e8095ee50d257a8a069da47ddacfbddde1286
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Sat Sep 30 19:44:12 2017 +0100

    Add some advice for pull requests
---
 CONTRIBUTING.md |   43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..2046ae7
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,43 @@
+Thanks for considering contributing to LaTeX3: 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/latex3/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 `expl3` (from your `.log`)
+- Your TeX system details (for example 'TeX Live 2017')
+- Which engine(s) you are using (_e.g._ pdfTeX)
+- Any additional packages that are needed to see the issue
+  (noting that of course we can only help with bugs in _our own code_)
+
+## Feature requests
+
+Feature requests are welcome: log them in the same way as bugs and pick
+the 'Enhancement' label.
+
+## 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).
+
+There are a few things you may need to bear in mind
+
+- `l3kernel` is 'broadly' stable so any changes there are best raised
+  first by mailing the team
+- New functions normally get added _via_ `l3candidates` or (for new
+  modules) `l3trial`
+
+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
+- 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]

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.