Browse Source

Add CONTRIBUTING.md and GitHub templates

master
Peter J. Jones 2 years ago
parent
commit
f2da028ff9
Signed by: Peter Jones <pjones@devalot.com> GPG Key ID: 9DAFAA8D01941E49
3 changed files with 104 additions and 0 deletions
  1. 24
    0
      .github/ISSUE_TEMPLATE.md
  2. 14
    0
      .github/PULL_REQUEST_TEMPLATE.md
  3. 66
    0
      CONTRIBUTING.md

+ 24
- 0
.github/ISSUE_TEMPLATE.md View File

@@ -0,0 +1,24 @@
1
+### Problem Description
2
+
3
+Describe the problem you are having, what you expect to happen
4
+instead, and how to reproduce the problem.
5
+
6
+### Configuration File
7
+
8
+Please include the smallest configuration file that reproduces the
9
+problem you are experiencing:
10
+
11
+```haskell
12
+module Main (main) where
13
+
14
+import XMonad
15
+
16
+main :: IO ()
17
+main = xmonad def
18
+```
19
+
20
+### Checklist
21
+
22
+  - [ ] I've read [CONTRIBUTING.md](https://github.com/xmonad/xmonad/blob/master/CONTRIBUTING.md)
23
+
24
+  - [ ] I tested my configuration with [xmonad-testing](https://github.com/xmonad/xmonad-testing)

+ 14
- 0
.github/PULL_REQUEST_TEMPLATE.md View File

@@ -0,0 +1,14 @@
1
+### Description
2
+
3
+Include a description for your changes, including the motivation
4
+behind them.
5
+
6
+### Checklist
7
+
8
+  - [ ] I've read [CONTRIBUTING.md](https://github.com/xmonad/xmonad/blob/master/CONTRIBUTING.md)
9
+
10
+  - [ ] I've confirmed these changes don't belong in xmonad-contrib instead
11
+
12
+  - [ ] I tested my changes with [xmonad-testing](https://github.com/xmonad/xmonad-testing)
13
+
14
+  - [ ] I updated the `CHANGES.md` file

+ 66
- 0
CONTRIBUTING.md View File

@@ -0,0 +1,66 @@
1
+# Contributing to xmonad and xmonad-contrib
2
+
3
+## Before Creating a GitHub Issue
4
+
5
+New issue submissions should adhere to the following guidelines:
6
+
7
+  * Does your issue have to do with [xmonad][], [xmonad-contrib][], or
8
+    maybe even with the [X11][] library?
9
+
10
+    Please submit your issue to the **correct** GitHub repository.
11
+
12
+  * To help you figure out which repository to submit your issue to,
13
+    and to help us resolve the problem you are having, create the
14
+    smallest configuration file you can that reproduces the problem.
15
+
16
+    You may find that the [xmonad-testing][] repository is helpful in
17
+    reproducing the problem with a smaller configuration file.
18
+
19
+    Once you've done that please include the configuration file with
20
+    your GitHub issue.
21
+
22
+  * If possible, use the [xmonad-testing][] repository to test your
23
+    configuration with the bleeding-edge development version of xmonad
24
+    and xmonad-contrib.  We might have already fixed your problem.
25
+
26
+## Contributing Changes/Patches
27
+
28
+Have a change to xmonad that you want included in the next release?
29
+Awesome!  Here are a few things to keep in mind:
30
+
31
+  * Review the above section about creating GitHub issues.
32
+
33
+  * It's always best to talk with the community before making any
34
+    nontrivial changes to xmonad.  There are a couple of ways you can
35
+    chat with us:
36
+
37
+    - Post a message to the [mailing list][ml].
38
+
39
+    - Join the `#xmonad` IRC channel on `chat.freenode.org`.
40
+
41
+  * Continue reading this document!
42
+
43
+## Expediting Reviews and Merges
44
+
45
+Here are some tips for getting your changes merged into xmonad:
46
+
47
+  * If your changes can go into [xmonad-contrib][] instead
48
+    of [xmonad][], please do so.  We rarely accept new features to
49
+    xmonad.  (Not that we don't accept changes to xmonad, just that we
50
+    prefer changes to xmonad-contrib instead.)
51
+
52
+  * Change the fewest files as possible.  If it makes sense, submit a
53
+    completely new module to xmonad-contrib.
54
+
55
+  * Your changes should include relevant entries in the `CHANGES.md`
56
+    file.  Help us communicate changes to the community.
57
+
58
+  * Make sure you test your changes using the [xmonad-testing][]
59
+    repository.  Include a new configuration file that shows off your
60
+    changes if possible by creating a PR on that repository as well.
61
+
62
+[xmonad]: https://github.com/xmonad/xmonad
63
+[xmonad-contrib]: https://github.com/xmonad/xmonad-contrib
64
+[xmonad-testing]: https://github.com/xmonad/xmonad-testing
65
+[x11]: https://github.com/xmonad/X11
66
+[ml]: https://mail.haskell.org/cgi-bin/mailman/listinfo/xmonad

Loading…
Cancel
Save