[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master 38979b5 18/62: Fixed up contributing documentation
From: |
Ian Dunn |
Subject: |
[elpa] master 38979b5 18/62: Fixed up contributing documentation |
Date: |
Sat, 9 Dec 2017 14:33:58 -0500 (EST) |
branch: master
commit 38979b50d517fd7e9bbc11e4b280f48278a52836
Author: Ian Dunn <address@hidden>
Commit: Ian Dunn <address@hidden>
Fixed up contributing documentation
* paced.org (Contributing): Broke into separate sections
(Documentation): New section in Contributing
---
paced.org | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)
diff --git a/paced.org b/paced.org
index b3aa3f6..31837fa 100644
--- a/paced.org
+++ b/paced.org
@@ -481,14 +481,17 @@ Build the Makefile with EDE:
1. Open any file from paced
2. Run ~C-c . C~ or ~M-x ede-compile-project~
-*Bugs*
+** Bugs
There are two ways to submit bug reports:
1. Using the bug tracker at Savannah
2. Sending an email using ~paced-submit-bug-report~
-*Development*
+When submitting a bug report, be sure to include a description of the
dictionary
+or population command that caused the problem, with as much detail as possible.
+
+** Development
If you're new to bazaar, we recommend using Emacs's built-in VC package. It
eases the overhead of dealing with a brand new VCS with a few standard
commands.
@@ -511,3 +514,12 @@ There are a few rules to follow:
- New population commands should be named
paced-POPULATION-COMMAND-TYPE-population-command
- Run 'make check' to verify that your mods don't break anything
- Avoid additional or altered dependencies if at all possible
+
+** Documentation
+
+Documentation is always helpful to us. Please be sure to do the following
after
+making any changes:
+
+1. Update the info page in the repository with ~C-c C-e i i~
+2. If you're updating the HTML documentation, switch to a theme that can easily
+ be read on a white background; we recommend the "adwaita" theme
- [elpa] master 52c8a88 10/62: Fixed usage of bzr send in documentation, (continued)
- [elpa] master 52c8a88 10/62: Fixed usage of bzr send in documentation, Ian Dunn, 2017/12/09
- [elpa] master 262d99f 13/62: Added package requirements to paced.el, Ian Dunn, 2017/12/09
- [elpa] master 79c22c2 06/62: Added new customization options for paced-load-all-dictionaries, Ian Dunn, 2017/12/09
- [elpa] master e404950 14/62: Alias if-let* and when-let* for backwards compatibility, Ian Dunn, 2017/12/09
- [elpa] master 6c014ae 15/62: Remove rx pcase form for compatibility, Ian Dunn, 2017/12/09
- [elpa] master ecb2f9d 12/62: Fixed up info title, Ian Dunn, 2017/12/09
- [elpa] master c369964 16/62: Reduce required Emacs version to 25.3, Ian Dunn, 2017/12/09
- [elpa] master de2260f 07/62: Documented the population commands, Ian Dunn, 2017/12/09
- [elpa] master febb200 08/62: Added function to submit a bug report, Ian Dunn, 2017/12/09
- [elpa] master b925c0b 17/62: Updated links in documentation, Ian Dunn, 2017/12/09
- [elpa] master 38979b5 18/62: Fixed up contributing documentation,
Ian Dunn <=
- [elpa] master 4162bd4 22/62: Changed name of registered checker, Ian Dunn, 2017/12/09
- [elpa] master 302d4b4 28/62: Added convenience method for adding population commands, Ian Dunn, 2017/12/09
- [elpa] master 4824306 21/62: Make the registered dictionary map a hash table, Ian Dunn, 2017/12/09
- [elpa] master e751e4f 24/62: Update case-handling slot name in Documentation, Ian Dunn, 2017/12/09
- [elpa] master dada473 19/62: Push of info page, Ian Dunn, 2017/12/09
- [elpa] master 6e7d6d7 29/62: Updated method names in paced-repopulate-dictionary-async, Ian Dunn, 2017/12/09
- [elpa] master ce7a2be 20/62: Changed case-sensitivity to case-handling, Ian Dunn, 2017/12/09
- [elpa] master 35ba53b 26/62: Autoload paced-repopulate-named-dictionary-async, Ian Dunn, 2017/12/09
- [elpa] master 6e8acdf 09/62: Added documentation, Ian Dunn, 2017/12/09
- [elpa] master 0d17d8d 25/62: Warn before resetting dictionary during population, Ian Dunn, 2017/12/09