@@ -34,8 +34,8 @@ Use your best judgment, and feel free to propose changes to this document in a p
## Code of Conduct
This project and everyone participating in it is governed by the
[Aaru Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please
report unacceptable behavior to [claunia@claunia.com](mailto:claunia@claunia.com).
[Aaru Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report
unacceptable behavior to [claunia@claunia.com](mailto:claunia@claunia.com).
## I don't want to read this whole thing I just have a question!!!
@@ -75,7 +75,8 @@ Aaru is intentionally very modular. Here's a list of them:
functions and commands that are called by the user interface itself.
* [Aaru.Decoders](https://github.com/aaru-dps/Aaru.Decoders) - This module contains internal disk, drive and protocol
structures as well as code to marshal, decode and print them.
* [Aaru.Decryption](https://github.com/aaru-dps/Aaru.Decryption) - This module contains the media decryption code, like CSS or CPRM.
* [Aaru.Decryption](https://github.com/aaru-dps/Aaru.Decryption) - This module contains the media decryption code, like
CSS or CPRM.
* [Aaru.Devices](https://github.com/aaru-dps/Aaru/tree/master/Aaru.Devices) - This module contains code to talk with
hardware devices in different platforms. Each platform has low-level calls in its own folder, and each device protocol
has high-level calls in its own folder. Device commands are separated by protocol standard, or vendor name.
@@ -104,8 +105,9 @@ Aaru is intentionally very modular. Here's a list of them:
* [Aaru.Tests](https://github.com/aaru-dps/Aaru/tree/master/Aaru.Tests) - This module contains the unit tests for the
rest of the modules. You should add new unit tests here but cannot run all of them because the test images they
require amount to more than 900 GiB.
* [Aaru.Tests.Devices](https://github.com/aaru-dps/Aaru/tree/master/Aaru.Tests.Devices) - This module presents a menu-driven interface to send commands to devices, as a way to test the Core module, as those tests cannot be automated. It
can be used to debug drive responses.
* [Aaru.Tests.Devices](https://github.com/aaru-dps/Aaru/tree/master/Aaru.Tests.Devices) - This module presents a
menu-driven interface to send commands to devices, as a way to test the Core module, as those tests cannot be
automated. It can be used to debug drive responses.
## How Can I Contribute?
@@ -133,8 +135,8 @@ mag_right:.
Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you
don't need to create one. When you are creating a bug report, please
[include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out
the required template, the information it asks for helps us resolve issues faster.
[include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out the required template, the
information it asks for helps us resolve issues faster.
> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
@@ -190,9 +192,8 @@ minor improvements to existing functionality. Following these guidelines helps m
your suggestion :pencil: and find related suggestions :mag_right:.
Before creating enhancement suggestions,
please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill
in the template, including the steps that you imagine you would take if the feature you're
requesting existed.
please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in the template,
including the steps that you imagine you would take if the feature you're requesting existed.
#### How Do I Submit A (Good) Enhancement Suggestion?
@@ -226,7 +227,8 @@ Do not modify the interfaces. If you need or want to, comment in an issue how an
discuss it. Same applies for creating new interfaces.
Aaru uses C# 8 language features (inline declaration, Tuples, etc.) so it can only be compiled
with [VisualStudio](http://www.visualstudio.com) 2019 or higher, [Visual Studio for Mac](https://www.xamarin.com/download)
with [VisualStudio](http://www.visualstudio.com) 2019 or
higher, [Visual Studio for Mac](https://www.xamarin.com/download)
2019 or higher, or [JetBrains Rider](https://www.jetbrains.com/rider/) 2019.1 or higher.
@@ -4,80 +4,105 @@ This document defines the project governance for Aaru.
## Overview
**Aaru**, an open source project, is committed to building an open, inclusive, and productive open source community focused on delivering a high quality tool that for backing up (dumping) various types of computer and game console media.
**Aaru**, an open source project, is committed to building an open, inclusive, and productive open source community
focused on delivering a high quality tool that for backing up (dumping) various types of computer and game console
media.
The community is governed by this document with the goal of defining how community should work together to achieve this goal.
The community is governed by this document with the goal of defining how community should work together to achieve this
goal.
## Code Repositories
The following code repositories are governed by Aaru community and maintained under the `aaru-dps` organization.
* **[010templates](https://github.com/aaru-dps/010templates):** Templates for [010editor](https://www.sweetscape.com/010editor).
* **[Aaru](https://github.com/aaru-dps/aaru):** Main Aaru codebase.
* **[aaruremote](https://github.com/aaru-dps/aaruremote):** Small application allowing to send Aaru commands to a different computer.
* **[aaruremote](https://github.com/aaru-dps/aaruremote):** Small application allowing to send Aaru commands to a
different computer.
* **[Aaru.Server](https://github.com/aaru-dps/Aaru.Server):** https://aaru.app server codebase.
* **[Aaru.VideoNow](https://github.com/aaru-dps/Aaru.VideoNow):** VideoNow decoding and converting tool.
* **[archaaru](https://github.com/aaru-dps/archaaru):** Scripts for the generation of Arch Linux Rescue CD including Aaru Data Preservation Suite.
* **[fstester](https://github.com/aaru-dps/fstester):** Toolkit for the generation of test filesystems for later reverse engineer.
* **[archaaru](https://github.com/aaru-dps/archaaru):** Scripts for the generation of Arch Linux Rescue CD including
Aaru Data Preservation Suite.
* **[fstester](https://github.com/aaru-dps/fstester):** Toolkit for the generation of test filesystems for later reverse
engineer.
* **[libaaruformat](https://github.com/aaru-dps/libaaruformat):** Main implementation of Aaru Media Image Format.
* **[RedBookPlayer](https://github.com/aaru-dps/RedBookPlayer):** Application to play Red Book audio from media dumps.
## Community Roles
* **Users:** Members that engage with the Aaru community via any medium (Discord, GitHub, etc.).
* **Contributors:** Regular contributions to projects (documentation, code reviews, responding to issues, participation in proposal discussions, contributing code, etc.).
* **Technical committee**: Provide input and feedback on roadmap items, grounded in common use cases for the committee member's organizations. Committee members might sponsor certain aspects of the project, however sponsorships are not a requirement for a committee member role.
* **Maintainers**: The Aaru project leaders. They are responsible for the overall health and direction of the project; final reviewers of PRs and responsible for releases. Some Maintainers are responsible for one or more components within a project, acting as technical leads for that component. Maintainers are expected to contribute code and documentation, review PRs including ensuring quality of code, triage issues, proactively fix bugs, and perform maintenance tasks for these components.
* **Contributors:** Regular contributions to projects (documentation, code reviews, responding to issues, participation
in proposal discussions, contributing code, etc.).
* **Technical committee**: Provide input and feedback on roadmap items, grounded in common use cases for the committee
member's organizations. Committee members might sponsor certain aspects of the project, however sponsorships are not a
requirement for a committee member role.
* **Maintainers**: The Aaru project leaders. They are responsible for the overall health and direction of the project;
final reviewers of PRs and responsible for releases. Some Maintainers are responsible for one or more components
within a project, acting as technical leads for that component. Maintainers are expected to contribute code and
documentation, review PRs including ensuring quality of code, triage issues, proactively fix bugs, and perform
maintenance tasks for these components.
### Maintainer nomination
New maintainers must be nominated by an existing maintainer and must be elected by a supermajority of existing maintainers. Likewise, maintainers can be removed by a supermajority of the existing maintainers or can resign by notifying one of the maintainers.
New maintainers must be nominated by an existing maintainer and must be elected by a supermajority of existing
maintainers. Likewise, maintainers can be removed by a supermajority of the existing maintainers or can resign by
notifying one of the maintainers.
### Technical committee member nomination
New technical committee members must be nominated by an existing member and must be elected by a supermajority of existing members. Likewise, members can be removed by a supermajority of the existing members or can resign by notifying one of the members.
New technical committee members must be nominated by an existing member and must be elected by a supermajority of
existing members. Likewise, members can be removed by a supermajority of the existing members or can resign by notifying
one of the members.
### Supermajority
A supermajority is defined as two-thirds of members in the group.
A supermajority of [Maintainers](MAINTAINERS.md) is required for certain decisions as outlined above. A supermajority vote is equivalent to the number of votes in favor being at least twice the number of votes against. For example, if you have 5 maintainers, a supermajority vote is 4 votes. Voting on decisions can happen on the mailing list, GitHub, Discord, email, or via a voting service, when appropriate. Maintainers can either vote "agree, yes, +1", "disagree, no, -1", or "abstain". A vote passes when supermajority is met. An abstain vote equals not voting at all.
A supermajority is defined as two-thirds of members in the group. A supermajority of [Maintainers](MAINTAINERS.md) is
required for certain decisions as outlined above. A supermajority vote is equivalent to the number of votes in favor
being at least twice the number of votes against. For example, if you have 5 maintainers, a supermajority vote is 4
votes. Voting on decisions can happen on the mailing list, GitHub, Discord, email, or via a voting service, when
appropriate. Maintainers can either vote "agree, yes, +1", "disagree, no, -1", or "abstain". A vote passes when
supermajority is met. An abstain vote equals not voting at all.
### Decision Making
We try to operate more on consensus than on votes, seeking agreement from the people who will have to do the work.
Natalia Portillo ([@claunia](https://github.com/claunia)) is the self-appointed benevolent dictator for life (SABDFL) for Aaru.
Natalia Portillo ([@claunia](https://github.com/claunia)) is the self-appointed benevolent dictator for life (SABDFL)
for Aaru.
The community functions best when it can reach broad consensus about a way forward. However, it is not uncommon in the open-source world for there to be multiple good arguments, no clear consensus, and for open questions to divide communities rather than enrich them. The debate absorbs the energy that might otherwise have gone towards the creation of a solution. In many cases, there is no one ‘right’ answer, and what is needed is a decision more than a debate. The SABDFL acts to provide clear leadership on difficult issues, and set the pace for the project.
The community functions best when it can reach broad consensus about a way forward. However, it is not uncommon in the
open-source world for there to be multiple good arguments, no clear consensus, and for open questions to divide
communities rather than enrich them. The debate absorbs the energy that might otherwise have gone towards the creation
of a solution. In many cases, there is no one ‘right’ answer, and what is needed is a decision more than a debate. The
SABDFL acts to provide clear leadership on difficult issues, and set the pace for the project.
## Lazy Consensus
To maintain velocity in Aaru, the concept of [Lazy
Consensus](http://en.osswiki.info/concepts/lazy_consensus) is practiced. Ideas
and / or proposals should be shared by maintainers via
GitHub with the appropriate maintainers tagged. Out of respect for other contributors,
major changes should also be accompanied by a notification on Discord or a note on the
mailing list (not created yet) as appropriate. Author(s) of proposal, Pull Requests,
issues, etc. will give a time period of no less than five (5) working days for
comment and remain cognizant of popular observed world holidays.
To maintain velocity in Aaru, the concept of [Lazy Consensus](http://en.osswiki.info/concepts/lazy_consensus) is
practiced. Ideas and / or proposals should be shared by maintainers via GitHub with the appropriate maintainers tagged.
Out of respect for other contributors, major changes should also be accompanied by a notification on Discord or a note
on the mailing list (not created yet) as appropriate. Author(s) of proposal, Pull Requests, issues, etc. will give a
time period of no less than five (5) working days for comment and remain cognizant of popular observed world holidays.
Other maintainers may chime in and request additional time for review, but
should remain cognizant of blocking progress and abstain from delaying
progress unless absolutely needed. The expectation is that blocking progress
is accompanied by a guarantee to review and respond to the relevant action(s)
Other maintainers may chime in and request additional time for review, but should remain cognizant of blocking progress
and abstain from delaying progress unless absolutely needed. The expectation is that blocking progress is accompanied by
a guarantee to review and respond to the relevant action(s)
(proposals, PRs, issues, etc.) in short order.
Lazy Consensus is practiced for all projects in the `aaru-dps` org, including
the main project repository and the additional repositories.
Lazy Consensus is practiced for all projects in the `aaru-dps` org, including the main project repository and the
additional repositories.
Lazy consensus does _not_ apply to the process of:
@@ -135,7 +135,7 @@ dumping of such characteristics. Usually those are copy protections.
- I Am Alive
- ObsCure II
- Shift 2 Unleashed
- Warfare
- Warfare
Information and test data
=========================
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
