.github/PULL_REQUEST_TEMPLATE.txt

   1 Please *do not* send pull-requests or open new issues on Github.
   2 See "hacking resources" below for recommended alternatives.
   3
   4 Github is a downstream mirror and is not frequently monitored,
   5 all development is coordinated upstream on GNU resources.
   6
   7 * Send general questions or suggestions to: coreutils@gnu.org .
   8 * Send bugs reports to: <bug-coreutils@gnu.org>
   9
  10 Before sending the bug, please consult the FAQ and Mailing list
  11 archives (see below).  Often these perceived bugs are simply due to
  12 wrong program usage.
  13
  14 Please remember that development of Coreutils is a volunteer effort,
  15 and you can also contribute to its development. For information about
  16 contributing to the GNU Project, please read
  17 [How to help GNU](https://www.gnu.org/help/].
  18
  19
  20 ## Getting Help
  21
  22 * Coreutils FAQ: https://www.gnu.org/software/coreutils/faq/coreutils-faq.html
  23
  24 * Coreutils Gotchas: https://www.pixelbeat.org/docs/coreutils-gotchas.html
  25   contains a list of some quirks and unexpected behavior (which are often
  26   mistaken for bugs).
  27
  28 * Online Manual:
  29   https://www.gnu.org/software/coreutils/manual/html_node/index.html
  30
  31 * Search the archives for previous questions and answers:
  32
  33    * Coreutils Mailing list (General usage and advice):
  34      https://lists.gnu.org/archive/html/coreutils/
  35
  36    * Bug reports Mailing List:
  37      https://lists.gnu.org/archive/html/bug-coreutils/
  38
  39 * Open Bugs: https://debbugs.gnu.org/cgi/pkgreport.cgi?which=pkg&data=coreutils
  40
  41 * Translation related issues:
  42   https://translationproject.org/domain/coreutils.html
  43
  44
  45 ## Mailing List Etiquette
  46
  47 When sending messages to coreutils@gnu.org or bug-coreutils@gnu.org :
  48
  49 * Send messages as plain text.
  50 * Do not send messages encoded as HTML nor encoded as base64 MIME nor
  51   included as multiple formats.
  52 * Include a descriptive subject line.
  53 * Avoid sending large messages, such as log files, system call trace
  54   output, and other content resulting in messages over about 40 kB.
  55 * Avoid sending screenshots (e.g. PNG files). When reporting errors
  56   you encounter on the terminal, copy and paste the text to your message.
  57 * List policy is reply-to-all, and non-subscribers may post.
  58 * There may be a moderation delay for a first-time post, whether or not
  59   you subscribe.
  60
  61
  62 ## Hacking resources
  63
  64 files contain information about hacking and contributing to GNU coreutils:
  65   https://git.savannah.gnu.org/cgit/coreutils.git/tree/HACKING
  66   https://git.savannah.gnu.org/cgit/coreutils.git/tree/README-hacking
  67 Please read them first.
  68
  69 Before suggesting a new feature, read the list of rejected features requests:
  70  https://www.gnu.org/software/coreutils/rejected_requests.html
  71
  72 Send a patch as an email attachment. Patches can be generated with
  73 `git format-patch` (the HACKING links above provide examples of generating
  74 a patch).
  75
  76
  77 ## Copyright Assignment
  78
  79 If your change is significant (i.e., if it adds more than ~10 lines),
  80 then you'll have to have a copyright assignment on file with the FSF.
  81 To learn more see https://www.gnu.org/licenses/why-assign.html .
  82
  83 The HACKING file (above) contains more details about how to initial
  84 the copyright assignment process.  Coreutils maintainers can also help
  85 in this matter.
  86
  87
  88
  89
  90 <!--
  91 Copyright (C) 2017-2024 Free Software Foundation, Inc.
  92
  93 This program is free software: you can redistribute it and/or modify
  94 it under the terms of the GNU General Public License as published by
  95 the Free Software Foundation, either version 3 of the License, or
  96 (at your option) any later version.
  97
  98 This program is distributed in the hope that it will be useful,
  99 but WITHOUT ANY WARRANTY; without even the implied warranty of
 100 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 101 GNU General Public License for more details.
 102
 103 You should have received a copy of the GNU General Public License
 104 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 105 -->