Beef up README.md and add CONTRIBUTING.md
This commit is contained in:
Adam Spiers
parent
205158a528
commit
64e0dc8793
4 changed files with 104 additions and 16 deletions
46
CONTRIBUTING.md
Normal file
46
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
Contributing to GNU Stow
|
||||
========================
|
||||
|
||||
Development of Stow, and GNU in general, is a volunteer effort, and
|
||||
you can contribute. If you'd like to get involved, it's a good idea to join
|
||||
the [stow-devel](https://lists.gnu.org/mailman/listinfo/stow-devel)
|
||||
mailing list.
|
||||
|
||||
Bug reporting
|
||||
-------------
|
||||
|
||||
Please follow the procedure described in [the "Reporting Bugs"
|
||||
section](https://www.gnu.org/software/stow/manual/html_node/Reporting-Bugs.html#Reporting-Bugs)
|
||||
of [the manual](README.md#documentation).
|
||||
|
||||
Development
|
||||
-----------
|
||||
|
||||
For [development sources](https://savannah.gnu.org/git/?group=stow)
|
||||
and other information, please see the [Stow project
|
||||
page](http://savannah.gnu.org/projects/stow/) at
|
||||
[savannah.gnu.org](http://savannah.gnu.org).
|
||||
|
||||
There is also a
|
||||
[stow-devel](https://lists.gnu.org/mailman/listinfo/stow-devel)
|
||||
mailing list (see [Mailing lists](README.md#mailing-lists)).
|
||||
|
||||
Translating Stow
|
||||
----------------
|
||||
|
||||
Stow is not currently multi-lingual, but patches would be very
|
||||
gratefully accepted. Please e-mail
|
||||
[stow-devel](https://lists.gnu.org/mailman/listinfo/stow-devel) if you
|
||||
intend to work on this.
|
||||
|
||||
Maintainers
|
||||
-----------
|
||||
|
||||
Stow is currently being maintained by Adam Spiers. Please use [the
|
||||
mailing lists](README.md#mailing-lists).
|
||||
|
||||
Helping the GNU project
|
||||
-----------------------
|
||||
|
||||
For more general information, please read [How to help
|
||||
GNU](https://www.gnu.org/help/).
|
||||
7
NEWS
7
NEWS
|
|
@ -9,8 +9,11 @@ News file for Stow.
|
|||
|
||||
*** Minor janitorial tasks
|
||||
|
||||
Users are not substantially affected by these behind-the-scenes
|
||||
changes.
|
||||
Users are not substantially affected by these changes.
|
||||
|
||||
***** Added some more information from the web page to the README
|
||||
|
||||
***** Added a CONTRIBUTING.md file
|
||||
|
||||
***** Removed texinfo.tex from the distribution
|
||||
|
||||
|
|
|
|||
62
README.md
62
README.md
|
|
@ -60,6 +60,56 @@ You can get the latest information about Stow from the home page:
|
|||
|
||||
http://www.gnu.org/software/stow/
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
See [`INSTALL.md`](INSTALL.md) for installation instructions.
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
Documentation for Stow is available
|
||||
[online](https://www.gnu.org/software/stow/manual/), as is
|
||||
[documentation for most GNU
|
||||
software](https://www.gnu.org/software/manual/). Once you have Stow
|
||||
installed, you may also find more information about Stow by running
|
||||
`info stow` or `man stow`, or by looking at `/usr/share/doc/stow/`,
|
||||
`/usr/local/doc/stow/`, or similar directories on your system. A
|
||||
brief summary is available by running `stow --help`.
|
||||
|
||||
Mailing lists
|
||||
-------------
|
||||
|
||||
Stow has the following mailing lists:
|
||||
|
||||
- [help-stow](https://lists.gnu.org/mailman/listinfo/help-stow) is for
|
||||
general user help and discussion.
|
||||
- [stow-devel](https://lists.gnu.org/mailman/listinfo/stow-devel) is
|
||||
used to discuss most aspects of Stow, including development and
|
||||
enhancement requests.
|
||||
- [bug-stow](https://lists.gnu.org/mailman/listinfo/bug-stow) is for
|
||||
bug reports.
|
||||
|
||||
Announcements about Stow are posted to
|
||||
[info-stow](http://lists.gnu.org/mailman/listinfo/info-stow) and also,
|
||||
as with most other GNU software, to
|
||||
[info-gnu](http://lists.gnu.org/mailman/listinfo/info-gnu)
|
||||
([archive](http://lists.gnu.org/archive/html/info-gnu/)).
|
||||
|
||||
Security reports that should not be made immediately public can be
|
||||
sent directly to the maintainer. If there is no response to an urgent
|
||||
issue, you can escalate to the general
|
||||
[security](http://lists.gnu.org/mailman/listinfo/security) mailing
|
||||
list for advice.
|
||||
|
||||
The Savannah project also has a [mailing
|
||||
lists](https://savannah.gnu.org/mail/?group=stow) page.
|
||||
|
||||
Getting involved
|
||||
----------------
|
||||
|
||||
Please see the [`CONTRIBUTING.md` file](CONTRIBUTING.md).
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
|
|
@ -71,18 +121,6 @@ are permitted in any medium without royalty provided the copyright
|
|||
notice and this notice are preserved. This file is offered as-is,
|
||||
without any warranty.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
See [`INSTALL.md`](INSTALL.md) for installation instructions.
|
||||
|
||||
Feedback
|
||||
--------
|
||||
|
||||
Please do send comments, questions, and constructive criticism. The
|
||||
mailing lists and any other communication channels are detailed on the
|
||||
above home page.
|
||||
|
||||
Brief history and authorship
|
||||
----------------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -1291,8 +1291,9 @@ adding @samp{--verbose=5} to the Stow command line).
|
|||
@end itemize
|
||||
|
||||
If you are really keen, consider developing a minimal test case and
|
||||
creating a new test. See the @file{t/} directory in the source for
|
||||
lots of examples.
|
||||
creating a new test. See the @file{t/} directory in the source for lots
|
||||
of examples, and the @file{CONTRIBUTING.md} file for a guide on how to
|
||||
contribute.
|
||||
|
||||
Before reporting a bug, please read the manual carefully, especially
|
||||
@ref{Known Bugs}, to see whether you're encountering
|
||||
|
|
|
|||
Loading…
Reference in a new issue