Browse Source

moved sosasa to attic, updated contributing.md

pull/93/head
jmf 4 months ago
parent
commit
337bc3e861
Signed by: jmf <jmf@lollipopcloud.solutions> GPG Key ID: 5F74BD822DD3B009
4 changed files with 30 additions and 42 deletions
  1. 28
    0
      CONTRIBUTING.md
  2. 2
    0
      attic/contributing/sosasa-kanban.md
  3. 0
    34
      contributing/CONTRIBUTING.md
  4. 0
    8
      contributing/README.md

+ 28
- 0
CONTRIBUTING.md View File

@@ -0,0 +1,28 @@
1
+# Contributing
2
+
3
+If you'd like to contribute, welcome!! We are so glad you are here. We hope you will take a moment to read our [code of conduct](../code-of-conduct.md) before continuing.
4
+
5
+
6
+
7
+- [Documentation repository](https://git.lollipopcloud.solutions/lollipop-cloud/docs)
8
+- [Code repository](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud)
9
+- [Docker-specific repositories](https://git.lollipopcloud.solutions/lollipop-docker/misc)
10
+
11
+Lowering the barrier for contributions is important: we value your input, regardless of your level of experience or area of expertise. If you would rather [contact us directly](https://lollipopcloud.solutions/page/contact/), please do not hesitate to reach out through email or chat.
12
+
13
+Note: by submitting a PR, you agree to your contribution(s) being licensed as described in our [LICENSE.md](../LICENSE.md).
14
+
15
+## Documentation
16
+
17
+**In order to ease the process of reading and applying docs, please:**
18
+
19
+*   Add an introduction for what the documentation is about (1-2 short paragraphs should suffice) before presenting links, code, etc., for the sake of context;
20
+*   Use plain language, because our users are diverse with a wide range of technical and non-technical backgrounds;
21
+*   Don't abbreviate or assume something is banal/easy/common knowledge (define acronyms on first use);
22
+*   Be specific, even when you believe "everyone knows this."
23
+
24
+**For extra readability purposes:**
25
+
26
+*   Use markdown, if possible, for different areas/topics among the doc, as well as plenty of white space;
27
+*   Separate configurations/commands from explanations with a code block (triple backtick).
28
+*   If you can't explain a "basic concept" in a easy way without making a wall of text in the middle of your doc, feel free to hyperlink to separate documentation where those concepts are already explained, be it Wikipedia or another doc that has high readability and reliability.

contributing/sosasa-kanban.md → attic/contributing/sosasa-kanban.md View File

@@ -1,3 +1,5 @@
1
+*This document has been archived. The SOSASA modified kanban approach was an integral part of the early days of the Lollipop project, and we leave it here as a resource for future projects and organizations looking for a contribution management system that's less developer oriented. As always, if you're interested in contributing to the Lollipop project and are not technically oriented, you can always reach out to us in the method most comfortable for you. We keep the contact page on our website up to date for such purposes.*
2
+
1 3
 # The Lollipop Cloud Project's Issue Reporting and Feature Requesting Process
2 4
 
3 5
 ## Definitions

+ 0
- 34
contributing/CONTRIBUTING.md View File

@@ -1,34 +0,0 @@
1
-# Contributing
2
-We use a modified kanban methodology called SOSASA (Structuring your project for the purposes Of Social Activism and Accessibility) for contributions. You can read about [our adaptation of SOSASA here (link)](sosasa-kanban.md), and creator hoodie aida kitten's complete onboarding article and [detailed SOSASA description here (link)](https://medium.com/@novemberninerniner/the-lifetime-of-an-issue-feature-request-f0ae1210e8c2).
3
-
4
-If you'd like to contribute, welcome!! We are so glad you are here. We hope you will take a moment to read our [code of conduct (link)](../code-of-conduct.md) before continuing.
5
-
6
-To contribute, please read [our adaptation of SOSASA here (link)](sosasa-kanban.md), which contains more detail about how you can contribute, then join our [kanban boards (link)](https://kanban.lollipopcloud.solutions/) by signing up for an account and logging in.
7
-
8
-* For documentation contributions, we have a [kanban board for documentation (link)](https://kanban.lollipopcloud.solutions/project/admin-lollipop-documentation/kanban/).
9
-
10
-* For code-related contributions, we have a [kanban board for code (link)](https://kanban.lollipopcloud.solutions/project/admin-lollipop-cloud/kanban/)
11
-
12
-...to read and comment on anything you see, or create a new issue by clicking the `+` sign at the top of the `Brainstorming` column.
13
-
14
-If you already have code or documentation to contribute, our [documentation repository is here (link)](https://git.lollipopcloud.solutions/lollipop-cloud/docs) and our [code repo is here (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud).
15
-
16
-Lowering the barrier for contributions is important: we value your input, regardless of your level of experience or area of expertise. If you would rather [contact us directly (link)](https://lollipopcloud.solutions/page/contact/), please do not hesitate to reach out through email or chat. We can also provide assistance walking you through our contribution process if you'd like to learn SOSASA or Gitea.
17
-
18
-Note: by submitting a PR, you agree to your contribution(s) being licensed as described in our [LICENSE.md (link)](../LICENSE.md).
19
-
20
-## Documentation
21
-
22
-**In order to ease up the process of reading and applying docs, please:**
23
-
24
-*   Add an intro to what the documentation is about (a couple of paragraphs should suffice) before presenting links, code, etc., for the sake of context - especially to the non-initiated;
25
-*   Make very clear what each step is and use language that anyone would understand (KISS);
26
-*   Don't abbreviate or assume something is banal/easy/common knowledge;
27
-*   Be specific even when it sounds like it's something everyone knows about.
28
-    Example of something that should be specified in docs: where to implement the stuff you just wrote about;
29
-
30
-**For extra readability purposes:**
31
-
32
-*   Use markdown, if possible, for different areas/topics among the doc (text vs code, for example), as well as space;
33
-*   Break apart config/commands from docs.
34
-*   If you can't explain a "basic concept" in a easy way without making a wall of text in the middle of your doc, feel free to hyperlink to other documentation where those concepts are already explained, be it Wikipedia or another doc online that has high readability and reliability;

+ 0
- 8
contributing/README.md View File

@@ -1,8 +0,0 @@
1
-# Welcome!
2
-
3
-We welcome your contributions!
4
-
5
-- [Read more about contribution guidelines here (link)](CONTRIBUTING.md)
6
-- [Read more about SOSASA, our modified kanban approach here (link)](sosasa-kanban.md)
7
-- [Our code of conduct is here (link)](../code-of-conduct.md)
8
-- If you're new to Git or Gitea, check out our ["how to gitea" documentation (link)](../for-beginners/how-to-gitea.md).

Loading…
Cancel
Save