[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/autothemer 9bde5000f4 19/29: CONTRIBUTING.md
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/autothemer 9bde5000f4 19/29: CONTRIBUTING.md |
Date: |
Sun, 28 Aug 2022 22:58:46 -0400 (EDT) |
branch: elpa/autothemer
commit 9bde5000f4decf1887c8b393750dc917daa0c871
Author: Jason Milkins <jasonm23@users.noreply.github.com>
Commit: jasonm23 <jasonm23@gmail.com>
CONTRIBUTING.md
---
CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++
1 file changed, 38 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000000..90b64bb8c1
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,38 @@
+# Contributing
+
+Welcome to Emacs AutoThemer. You can contribute to the project in the
following ways:
+
+- **Bug reports:** One liner reports are difficult to understand and review.
+ - Follow the bug reporting issue template and provide clear, concise
descriptions and steps to reproduce the bug.
+ - Ensure that you have searched the existing issues to avoid duplicates.
+ - Maintainers may close unclear issues that lack enough information to
reproduce a bug. [Report a bug here](https://github.com/issues).
+ - Maintainers WILL close issues if they cannot be reliably and repeatedly
reproduced, without loading your config.
+
+- **Feature suggestions:** If you feel there is a nice enhancement or feature
that can benefit many users, please open a feature request issue.
+ - Ensure that you have searched the existing issues to avoid duplicates.
+ - What makes sense for the project, what suits its scope and goals, and
its future direction are at the discretion of the maintainers who put in the
time, effort, and energy in building and maintaining the project for free.
Please be respectful of this and keep discussions friendly and fruitful.
+ - It is the responsibility of the requester to clearly explain and
justify why a change is warranted. It is not the responsibility of the
maintainers to coax this information out of a requester. So, please post well
researched, well thought out, and detailed feature requests saving everyone
time.
+ - Maintainers may close unclear feature requests that lack enough
information. [Suggest a feature
here](https://github.com/jasonm23/autothemer/issues).
+
+- **Pull requests**
+ This is a tricky one for many reasons. A PR, be it a new feature or a small
enhancement, has to make sense to the project's overall scope, goals, and
technical aspects. The quality, style, and conventions of the code have to
conform to that of the project's. Performance, usability, stability and other
kinds of impacts of a PR should be well understood.
+
+ This makes reviewing PRs a difficult and time consuming task. The bigger a
PR, the more difficult it is to understand. Reviewing a PR in detail, engaging
in back and forth discussions to improve it, and deciding that it is meaningful
and safe to merge can often require more time and effort than what has gone
into creating a PR. Thus, ultimately, whether a PR gets accepted or not, for
whatever reason, is at the discretion of the maintainers. Please be respectful
of the fact that maintai [...]
+
+ To keep the process smooth **send small PRs:** Whenever possible, send small
PRs with well defined scopes. The smaller the PR, the easier it is to review
and test. Bundling multiple features into a single PR is highly discouraged.
+
+- **Be respectful**
+ Remember, most FOSS projects are fruits of love and labour of maintainers
who share them with the world for free with no expectations of any returns.
Free as in freedom, and free as in beer too. Really, *some people just want to
watch the world turn*.
+
+### So:
+
+- Please be respectful and refrain from using aggressive or snarky language.
It wastes time, energy, cognitive bandwidth, and goodwill.
+- Please refrain from demanding. How badly you want a feature has no bearing
on whether it warrants a maintainer's time or attention. It is entirely up to
the maintainers, if, how, and when they want to implement something.
+- Please do not nitpick and generate unnecessary discussions that waste time.
+- Please make sure you have searched the docs and issues before asking support
questions.
+- **Please remember, FOSS project maintainers owe you nothing** (unless you
have an explicit agreement with them, of course) including their time in
responding to your messages or providing free customer support. If you want to
be heard, please be respectful and establish goodwill.
+- If these are unacceptable to you
+ - You don't have to use the project
+ - You can always fork the project and change it to your liking while
adhering to the terms of the license. That is the beauty of FOSS, afterall.
+
+Thank you
- [nongnu] elpa/autothemer 0d39a92d90 07/29: Fix naming of README.md, (continued)
- [nongnu] elpa/autothemer 0d39a92d90 07/29: Fix naming of README.md, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer a528436677 16/29: 0.2.10, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer b0df7578fc 17/29: Additional parameters for svg generator., ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer 5d7ae3a0be 06/29: Rainbow mode: Colorize names from palette, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer 55db54a2ef 08/29: User parameters added for SVG generator, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer 12dbb2e605 15/29: Merge branch 'master' into develop, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer 67224c4a4c 21/29: Fix test run, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer 726d5b99bb 05/29: Only supporting 26.1 and above, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer 2b55532e0a 10/29: Fix test runner, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer f4ab56f44f 13/29: Structural change v-stacking, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer 9bde5000f4 19/29: CONTRIBUTING.md,
ELPA Syncer <=
- [nongnu] elpa/autothemer 0b558a7cab 20/29: Update autothemer.el, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer 882fd8f7bb 22/29: Update README, bin/test & SVG swatch sort hue-sat, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer 77ad2ec093 23/29: Trigger actions for pushes to master, or PRs, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer 1bc52d721d 27/29: Add issue templates, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer 97f7276eb1 28/29: Merge Pull request #23 from develop, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer f3a23b4b6d 29/29: Image moved to images branch, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer c6167daa05 09/29: Name test workflow, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer 9fe64dd3cd 14/29: Page placement looks better, needs polishing, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer cd7c3e7dd4 24/29: Add CONTRIBUTING to README, ELPA Syncer, 2022/08/28
- [nongnu] elpa/autothemer 180143b7fe 25/29: Add NEWS to README, ELPA Syncer, 2022/08/28