Merge branch 'contribbranch' of jmf/lollipop-docs into master
This commit is contained in:
jmf
Gitea
commit
deff2cf726
|
|
@ -1,6 +1,18 @@
|
|||
# Contributing
|
||||
The creator of what we use for project management has written an [onboarding article](https://medium.com/@novemberninerniner/the-lifetime-of-an-issue-feature-request-f0ae1210e8c2)(link) for new users, that you can read for a quick rundown. The blueprint for this structuring sytem of the [S.O.S.A.S.A. ideology](http://https://medium.com/@novemberninerniner/structuring-your-open-source-project-for-the-purposes-of-accessibility-social-activism-6b1d7fe6c97d)(link) of project management is another deeper read. It's not as scary as it sounds, and just means we use a Kanban board (think trello). You do not need to read the SOSASA article, just the onboarding one, to get into it.
|
||||
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).
|
||||
|
||||
If you'd like to contribute, please read the above and login to the [kanban documentation board](https://kanban.lollipop.holdmybeer.solutions/project/admin-lollipop-documentation/kanban)(link) to read up and comment on anything you can glance at, or and setup a pull request if you've got a contribution to an existing issue, in the appropriate repo under this [list](https://git.lollipop.holdmybeer.solutions/explore/repos)(link).
|
||||
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.
|
||||
|
||||
Note: by submitting a PR you agree to your contribution(s) being licensed under the GPL v3 or Creative Commons Attribution 4.0 International License. Please see [LICENSE.md](LICENSE.md) for further details.
|
||||
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.
|
||||
|
||||
* For documentation contributions, we have a [kanban board for documentation (link)](https://kanban.lollipopcloud.solutions/project/admin-lollipop-documentation/kanban/).
|
||||
|
||||
* For code-related contributions, we have a [kanban board for code (link)](https://kanban.lollipopcloud.solutions/project/admin-lollipop-cloud/kanban/)
|
||||
|
||||
...to read and comment on anything you see, or create a new issue by clicking the `+` sign at the top of the `Brainstorming` column.
|
||||
|
||||
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).
|
||||
|
||||
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.
|
||||
|
||||
Note: by submitting a PR, you agree to your contribution(s) being licensed as described in our [LICENSE.md (link)](LICENSE.md).
|
||||
|
|
|
|||
|
|
@ -1,55 +0,0 @@
|
|||
# The Lollipop Cloud Project's Issue Reporting and Feature Requesting Process
|
||||
|
||||
## Definitions
|
||||
(or skip to the [Introduction](#Introduction) below.)
|
||||
|
||||
* __Kanban:__ A [kanban board (link)](https://en.wikipedia.org/wiki/Kanban#Electronic_kanban) is a means of visualizing the workflow of a project or organization. It is presented as a set of lists arranged horizontally by status, with each status containing vertical lists of cards (or items).
|
||||
|
||||
* __SOSASA:__ "Structuring your project for the purposes Of Social Activism and Accessibility," or SOSASA/sosasa, is a kanban-based methodology for tracking issues and feature requests, and described in detail by creator hoodie aida kitten in [this SOSASA methodology Medium article (link)](https://medium.com/@novemberninerniner/the-lifetime-of-an-issue-feature-request-f0ae1210e8c2).
|
||||
|
||||
* __Issue:__ An issue is a vague word to describe anything you'd like to change about a project. This could be any problem, such as an error message or an unexpected behavior (a "bug"), an unmet accessibility need, inadequate documentation, a request to improve an existing feature, or a request for a new feature.
|
||||
|
||||
## Introduction
|
||||
|
||||
The Lollipop Cloud project has adopted the SOSASA methodology for tracking issues and feature requests. SOSASA functions through a system of phases, which we have tailored and outlined in the [Phases](#phases) section below.
|
||||
|
||||
The Lollipop Cloud project has a [sample kanban board here (link)](https://kanban.lollipopcloud.solutions/project/admin-template-kanban/kanban).
|
||||
|
||||
## How to request a feature or report an issue
|
||||
You will need to create an account and [login (link)](https://kanban.lollipopcloud.solutions/login?next=%252Fdiscover) to the [Lollipop Cloud project's kanban page (link)](https://kanban.lollipopcloud.solutions/).
|
||||
|
||||
* For documentation issues, go to the [kanban board for documentation (link)](https://kanban.lollipopcloud.solutions/project/admin-lollipop-documentation/kanban/).
|
||||
|
||||
* For code-related issues, go to the [kanban board for code (link)](https://kanban.lollipopcloud.solutions/project/admin-lollipop-cloud/kanban/)
|
||||
|
||||
Click the `+` sign at the top of the brainstorming column. (Any `+` button will work, just ensure the drop down menu in the middle of the popup window has `Brainstorming` selected from all the [Phases](#Phases) in the list.)
|
||||
|
||||
Provide as many details as possible to describe the issue or new feature. Attaching screenshots or links to examples are very helpful.
|
||||
|
||||
**Please note:** You do not need to be an expert in the technology to contribute. Your best effort to describe an issue or new feature in your own words is enough, and we are grateful!
|
||||
|
||||
## Phases
|
||||
|
||||
### Phase 1: Brainstorming
|
||||
During brainstorming, the issue (bug) or feature request is defined. An issue will be created in the [Lollipop Cloud project's kanban page (link)](https://kanban.lollipopcloud.solutions/), and its status can be tracked here at any given time. At this time we use two separate boards: [documentation (link)](https://kanban.lollipopcloud.solutions/project/admin-lollipop-documentation/kanban/) and [code (link)](https://kanban.lollipopcloud.solutions/project/admin-lollipop-cloud/kanban/).
|
||||
|
||||
### Phase 2: Mock-ups or visual design
|
||||
This is where the details are described or visualized. Details can involve physical appearance such as user interface (UI) or wireframes, or can be an outline of actions, such as desired feature behaviors.
|
||||
|
||||
### Phase 3: Polling or appeals
|
||||
Once a mock-up is created, participants can vote in favor or against the mock-up, and provide feedback. Polls can be formal (using a tallied voting tool) or informal (providing feedback in favor/against), and feedback can be anything, including suggestions for clarification or improvement.
|
||||
If changes are needed, the item goes back to the mock-ups/visual design phase for reworking. If no changes are needed, the item proceeds to the next phase.
|
||||
|
||||
### Phase 4: Development or implementation
|
||||
Contributors (coders, writers, artists, etc) attempt to put the mockup or design into practice. If problems arise, the issue goes back to the mockups and design phase for discussion. Once the item is implemented, it proceeds to the next phase.
|
||||
|
||||
### Phase 5: Review
|
||||
At this phase, the implementation is evaluated to determine if it meets the goal that was defined during the brainstorming phase. If the goal was not met, the item moves back to an appropriate phase for reworking. If the goal was met, the item proceeds to the next phase.
|
||||
|
||||
### Phase 6: Archival
|
||||
Completed items are archived so they may be revisited for bug tracking and continuous improvement.
|
||||
|
||||
## Conclusion
|
||||
We hope this will provide the greatest transparency for the Lollipop Cloud Project, and lower the barrier for participation and contribution.
|
||||
|
||||
If you have questions or feedback about the Lollipop Cloud Project's adaptation of SOSASA methodology, please [contact us (link)](https://lollipopcloud.solutions/page/contact). If you have questions about SOSASA, please contact the methodology's creator, [hoodie aida kitten (link)](https://abandoneddoll.neocities.org/).
|
||||
Reference in New Issue