mirror of
https://github.com/aaru-dps/Aaru.Documentation.git
synced 2025-12-16 11:14:32 +00:00
Updated documentation.
This commit is contained in:
@@ -67,8 +67,7 @@
|
||||
- [Changelog](docs/Changelog.md)
|
||||
- [Code of conduct](docs/CODE_OF_CONDUCT.md)
|
||||
- [Contributing](docs/CONTRIBUTING.md)
|
||||
- [Donating](docs/NEEDED.md)
|
||||
- [Information needed](docs/NEEDINFO.md)
|
||||
- [Needed media and information](docs/NEEDED.md)
|
||||
- [Maintainers](docs/MAINTAINERS.md)
|
||||
- [Project governance](docs/GOVERNANCE.md)
|
||||
- [Read me](docs/README.md)
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
|
||||
participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
|
||||
disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status,
|
||||
disability, ethnicity, gender identity and expression, level of experience, education, socioeconomic status,
|
||||
nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
@@ -54,7 +54,7 @@ repercussions as determined by other members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][https://www.contributor-covenant.org], version 1.4, available
|
||||
at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
@@ -29,12 +29,12 @@ Use your best judgment, and feel free to propose changes to this document in a p
|
||||
[Styleguides](#styleguides)
|
||||
|
||||
* [Git Commit Messages](#git-commit-messages)
|
||||
* [Code Styleguide](#code-styleguide)
|
||||
* [Code Styleguide](#code-style-guide)
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
This project and everyone participating in it is governed by the
|
||||
[Aaru Code of Conduct](.github/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please
|
||||
[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,11 +75,12 @@ 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.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 lowlevel calls in its own folder, and each device protocol
|
||||
has highlevel calls in its own folder. Device commands are separated by protocol standard, or vendor name.
|
||||
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.
|
||||
* [Aaru.Device.Report](https://github.com/aaru-dps/Aaru/tree/master/Aaru.Device.Report) - This is a separate application
|
||||
in C89 designed to create device reports on enviroments where you can't run .NET or Mono but can run Linux.
|
||||
in C89 designed to create device reports on environments where you can't run .NET or Mono but can run Linux.
|
||||
* [Aaru.DiscImages](https://github.com/aaru-dps/Aaru/tree/master/Aaru.DiscImages) - This module provides reading
|
||||
capabilities for the disk/disc images, one per file.
|
||||
* [Aaru.DiscImages](https://github.com/aaru-dps/Aaru.Dto) - This module provides common structures between Aaru and
|
||||
@@ -89,8 +90,8 @@ Aaru is intentionally very modular. Here's a list of them:
|
||||
folder should be used.
|
||||
* [Aaru.Filters](https://github.com/aaru-dps/Aaru/tree/master/Aaru.Filters) - A filter is a modification of the data
|
||||
before it can be passed to the disk image module
|
||||
(compression, fork union, etc), and this module provides support for them. If a image is compressed, say in gzip, or
|
||||
encoded, say in AppleDouble, a filter is the responsible of decompressing or decoding it on-the-fly.
|
||||
(compression, fork union, etc.), and this module provides support for them. If an image is compressed, say in gzip, or
|
||||
encoded, say in AppleDouble, a filter is the responsible for decompressing or decoding it on-the-fly.
|
||||
* [Aaru.Helpers](https://github.com/aaru-dps/Aaru.Helpers) - This module contains a collection of helpers for array
|
||||
manipulation, big-endian marshalling, datetime conversion, hexadecimal printing, string manipulation and byte
|
||||
swapping.
|
||||
@@ -102,21 +103,20 @@ Aaru is intentionally very modular. Here's a list of them:
|
||||
Aaru settings.
|
||||
* [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 100GiB.
|
||||
* [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
|
||||
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.
|
||||
|
||||
## How Can I Contribute?
|
||||
|
||||
### Reporting Devices
|
||||
|
||||
Aaru tries to be as universal as possible. However some devices do not behave in the expected ways, some media is
|
||||
Aaru tries to be as universal as possible. However, some devices do not behave in the expected ways, some media is
|
||||
unknown and needs to be known prior to enabling dumping of it, etc.
|
||||
|
||||
For that reason, Aaru includes
|
||||
the [device-report command](https://github.com/aaru-dps/Aaru/wiki/Reporting-physical-device-capabilities). Using this
|
||||
command will guide you thru a series of questions about the device, and if it contains removable media, for you to
|
||||
command will guide you through a series of questions about the device, and if it contains removable media, for you to
|
||||
insert the different media you have, and create a report of its abilities. The report will automatically be sent to our
|
||||
server and saved on your computer. Please note that we do not store any personal information and when possible remove
|
||||
the drive serial numbers from the report.
|
||||
@@ -134,15 +134,15 @@ 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](.github/ISSUE_TEMPLATE.md), the information it asks for helps us resolve issues faster.
|
||||
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.
|
||||
|
||||
#### Before Submitting A Bug Report
|
||||
|
||||
* **Check the [wiki](https://github.com/aaru-dps/Aaru/wiki)** for a list of common questions and problems.
|
||||
* **Check the [documentation](https://aaru.app)** for a list of common questions and problems.
|
||||
* **Determine [which module the problem should be reported in](#aaru-and-modules)**.
|
||||
* **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Aclaunia)**
|
||||
* **Perform a [cursory search](https://github.com/search?q=+is%3Aissue)**
|
||||
to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the
|
||||
existing issue instead of opening a new one.
|
||||
|
||||
@@ -150,8 +150,7 @@ don't need to create one. When you are creating a bug report, please
|
||||
|
||||
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). After you've
|
||||
determined [which module](#aaru-and-modules) your bug is related to, create an issue on that repository and provide the
|
||||
following information by filling in
|
||||
[the template](.github/ISSUE_TEMPLATE.md).
|
||||
following information by filling in the template.
|
||||
|
||||
Explain the problem and include additional details to help maintainers reproduce the problem:
|
||||
|
||||
@@ -192,7 +191,7 @@ 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](.github/ISSUE_TEMPLATE.md), including the steps that you imagine you would take if the feature you're
|
||||
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,16 +225,15 @@ If you want to read about using Aaru, the [wiki](https://github.com/aaru-dps/Aar
|
||||
Do not modify the interfaces. If you need or want to, comment in an issue how and why you want to change it and we'll
|
||||
discuss it. Same applies for creating new interfaces.
|
||||
|
||||
Aaru uses C# 7 language features (inline declaration, Tuples, etc.) so it can only be compiled
|
||||
with [VisualStudio](http://www.visualstudio.com) 2017 or higher, [Xamarin Studio](https://www.xamarin.com/download)
|
||||
7 or higher, [MonoDevelop](http://www.monodevelop.com) 7 or higher,
|
||||
or [JetBrains Rider](https://www.jetbrains.com/rider/) 2017.2 or higher.
|
||||
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)
|
||||
2019 or higher, or [JetBrains Rider](https://www.jetbrains.com/rider/) 2019.1 or higher.
|
||||
|
||||
### Pull Requests
|
||||
|
||||
* Fill in [the required template](.github/PULL_REQUEST_TEMPLATE.md)
|
||||
* Fill in [the required template](PULL_REQUEST_TEMPLATE.md)
|
||||
* Do not include issue numbers in the PR title
|
||||
* Follow the [code styleguide](#code-styleguide).
|
||||
* Follow the [code styleguide](#code-style-guide).
|
||||
* Include test files as applicable, that do not have software under copyright inside them, if possible.
|
||||
* Document new code based using XML documentation wherever possible.
|
||||
* DO NOT end files with a newline.
|
||||
@@ -265,7 +263,7 @@ for them.
|
||||
|
||||
* Use the present tense ("Add feature" not "Added feature")
|
||||
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
|
||||
* Limit the first line to 72 characters or less
|
||||
* Limit the first line to 72 characters or fewer
|
||||
* Reference issues and pull requests liberally after the first line
|
||||
|
||||
### Code Style Guide
|
||||
@@ -282,7 +280,7 @@ for them.
|
||||
- If you will only store variables, use a struct. If you need it to be nullable, use a nullable struct if applicable.
|
||||
- Indent statements and cases.
|
||||
- Indent using 4 spaces (soft tab).
|
||||
- Instace and static fields should be lowerCamelCase.
|
||||
- Instance and static fields should be lowerCamelCase.
|
||||
- Public fields should be UpperCamelCase.
|
||||
- Separate attributes.
|
||||
- Use 120 columns margins.
|
||||
@@ -291,7 +289,7 @@ for them.
|
||||
- Use implicit modifiers.
|
||||
- Use inline variable declaration.
|
||||
- Use struct implicit constructor.
|
||||
- Use UNIX (`\n`) endline character.
|
||||
- Use UNIX (`\n`) end line character.
|
||||
|
||||
> Note: There is an included editorconfig file that sets the appropriate code style.
|
||||
|
||||
|
||||
@@ -4,104 +4,80 @@ 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.
|
||||
|
||||
* **[Aaru](https://github.com/aaru-dps/aaru):** Main Aaru codebase.
|
||||
* **[Aaru.Documentation](https://github.com/aaru-dps/Aaru.Documentation):** Official documentation.
|
||||
* **[Aaru.Decryption](https://github.com/aaru-dps/Aaru.Decryption):** Library for the decryption of media.
|
||||
* **[Aaru.CommonTypes](https://github.com/aaru-dps/Aaru.CommonTypes):** Common types needed by the different Aaru
|
||||
modules.
|
||||
* **[Aaru.Decoders](https://github.com/aaru-dps/Aaru.Decoders):** Library for the decoding of structures from media and
|
||||
drives.
|
||||
* **[Aaru.Server](https://github.com/aaru-dps/Aaru.Server):** https://aaru.app server codebase.
|
||||
* **[fstester](https://github.com/aaru-dps/fstester):** Toolkit for the generation of test filesystems for later reverse
|
||||
engineer.
|
||||
* **[aaruremote](https://github.com/aaru-dps/aaruremote):** Small application allowing to send Aaru commands to a
|
||||
different computer.
|
||||
* **[Aaru.Dto](https://github.com/aaru-dps/Aaru.Dto):** DTOs for interchange between client and server portions of Aaru.
|
||||
* **[Aaru.Console](https://github.com/aaru-dps/Aaru.Console):** Text console handler.
|
||||
* **[Aaru.Helpers](https://github.com/aaru-dps/Aaru.Helpers):** Helper functions.
|
||||
* **[010templates](https://github.com/aaru-dps/010templates):** Templates for [010editor](https://www.sweetscape.com/010editor).
|
||||
* **[Aaru.Checksums](https://github.com/aaru-dps/Aaru.Checksums):** Library that implements the hashing functionality.
|
||||
* **[010templates](https://github.com/aaru-dps/010templates):** Templates
|
||||
for [010editor](https://www.sweetscape.com/010editor).
|
||||
* **[libaaruformat](https://github.com/aaru-dps/libaaruformat):** Main implementation of Aaru Media Image Format.
|
||||
* **[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.
|
||||
* **[Aaru.CommonTypes](https://github.com/aaru-dps/Aaru.CommonTypes):** Common types needed by the different Aaru modules.
|
||||
* **[Aaru.Console](https://github.com/aaru-dps/Aaru.Console):** Text console handler.
|
||||
* **[Aaru.Decoders](https://github.com/aaru-dps/Aaru.Decoders):** Library for the decoding of structures from media and drives.
|
||||
* **[Aaru.Decryption](https://github.com/aaru-dps/Aaru.Decryption):** Library for the decryption of media.
|
||||
* **[Aaru.Documentation](https://github.com/aaru-dps/Aaru.Documentation):** Official documentation.
|
||||
* **[Aaru.Dreamcast](https://github.com/aaru-dps/Aaru.Dreamcast):** Tool for dumping GD-ROM using a real Dreamcast.
|
||||
* **[Aaru.Dto](https://github.com/aaru-dps/Aaru.Dto):** DTOs for interchange between client and server portions of Aaru.
|
||||
* **[Aaru.Helpers](https://github.com/aaru-dps/Aaru.Helpers):** Helper functions.
|
||||
* **[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.
|
||||
* **[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.
|
||||
* **[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) 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:
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
# Aaru Maintainers and Stakeholders
|
||||
|
||||
[GOVERNANCE.md](https://github.com/aaru-dps/aaru/blob/main/GOVERNANCE.md) describes governance guidelines and maintainer
|
||||
responsibilities.
|
||||
[GOVERNANCE.md](https://github.com/aaru-dps/aaru/blob/main/GOVERNANCE.md) describes governance guidelines and maintainer responsibilities.
|
||||
|
||||
## Maintainers
|
||||
|
||||
@@ -10,6 +9,7 @@ responsibilities.
|
||||
| Natalia Portillo | [claunia](https://github.com/claunia) | [Aaru](https://aaru.app) |
|
||||
| Michael Drüing | [darkstar](https://github.com/darkstar) | [Aaru](https://aaru.app) |
|
||||
| Rebecca Wallander | [FakeShemp](https://github.com/FakeShemp) | [Aaru](https://aaru.app) |
|
||||
| Matt Nadareski | [mnadareski](https://github.com/mnadareski) | [Aaru](https://aaru.app) |
|
||||
|
||||
## Technical committee
|
||||
|
||||
@@ -26,4 +26,3 @@ responsibilities.
|
||||
| Development | Michael Drüing | [darkstar](https://github.com/darkstar) | [Aaru](https://aaru.app) |
|
||||
| Development | Rebecca Wallander | [FakeShemp](https://github.com/FakeShemp) | [Aaru](https://aaru.app) |
|
||||
| QA | Silas Laspada | [SilasLaspada](https://github.com/SilasLaspada) | [Aaru](https://aaru.app) |
|
||||
| MPF (UI) | Matt Nadareski | [mnadareski](https://github.com/mnadareski) | SabreTools |
|
||||
|
||||
@@ -12,12 +12,10 @@ special workarounds. If a drive is listed here, but the media it uses is not lis
|
||||
Drives are preferred in ATA/ATAPI, SCSI, USB or FireWire buses. Parallel port drives require a larger amount of work,
|
||||
and there is no guarantee it can work, at all, with other drives. If in doubt, please contact us.
|
||||
|
||||
- 5.25" magneto-optical (preferibly the 9.6Gb supporting one)
|
||||
- 8" shugart floppy drive (preferibly the 240VAC one)
|
||||
- ADR tape drive
|
||||
- AIT tape drive
|
||||
- Apple FileWare "twiggy"
|
||||
- Caleb UHD144
|
||||
- Castlewood Orb 5.7
|
||||
- DLT tape drive
|
||||
- DiscFerret
|
||||
@@ -50,7 +48,6 @@ hardware.
|
||||
- ADR tapes
|
||||
- AIT tapes
|
||||
- Apple FileWare "twiggy" floppies
|
||||
- Caleb UHD144 floppy
|
||||
- Castlewood Orb 5.7
|
||||
- DLTtape, DLTtapeII, DLTtapeIII
|
||||
- Rewritable HD-DVD
|
||||
@@ -138,4 +135,16 @@ dumping of such characteristics. Usually those are copy protections.
|
||||
- I Am Alive
|
||||
- ObsCure II
|
||||
- Shift 2 Unleashed
|
||||
- Warfare
|
||||
- Warfare
|
||||
|
||||
Information and test data
|
||||
=========================
|
||||
|
||||
This is a list of information I need, including test disk images.
|
||||
|
||||
- DiscFerret stream images
|
||||
- Information about the KenCode compression algorithm, or an implementation in C or Pascal
|
||||
- Information about the structure and compression algorithm for XPACK disk images, or an implementation in C
|
||||
- KryoFlux stream images
|
||||
- NetWare 286 license and installation media for adding support to its filesystem
|
||||
- NetWare 386 license and installation media for adding support to its filesystem
|
||||
@@ -1,11 +0,0 @@
|
||||
Information and test data
|
||||
=========================
|
||||
|
||||
This is a list of information I need, including test disk images.
|
||||
|
||||
- DiscFerret stream images
|
||||
- Information about the KenCode compression algorithm, or an implementation in C or Pascal
|
||||
- Information about the structure and compression algorithm for XPACK disk images, or an implementation in C
|
||||
- KryoFlux stream images
|
||||
- NetWare 286 license and installation media for adding support to its filesystem
|
||||
- NetWare 386 license and installation media for adding support to its filesystem
|
||||
16
docs/PULL_REQUEST_TEMPLATE.md
Normal file
16
docs/PULL_REQUEST_TEMPLATE.md
Normal file
@@ -0,0 +1,16 @@
|
||||
## Types of changes
|
||||
|
||||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
|
||||
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] New filesystem, test images in [url]
|
||||
- [ ] New media image, test images in [url]
|
||||
- [ ] New partition scheme, test images in [url]
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
||||
- [ ] I have read the **CONTRIBUTING** document.
|
||||
- [ ] My code follows the code style of this project.
|
||||
- [ ] My change requires a change to the documentation.
|
||||
- [ ] I have updated the documentation accordingly.
|
||||
- [ ] I have added tests to cover my changes.
|
||||
- [ ] All new and existing tests passed.
|
||||
@@ -9,7 +9,7 @@ Copyright © 2011-2021 Natalia Portillo <claunia@claunia.com>
|
||||
[](https://ci.appveyor.com/project/claunia/aaru)
|
||||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fclaunia%2FDiscImageChef?ref=badge_shield)
|
||||
|
||||
You can see statistics and device reports [here](https://www.aaru.app/Stats)
|
||||
You can see user documentation [here](https://www.aaru.app)
|
||||
|
||||
Aaru is a fully featured media dump management solution. You usually know media dumps as disc images, disk images, tape
|
||||
images, etc.
|
||||
@@ -38,7 +38,7 @@ aaru.exe
|
||||
|
||||
And read help.
|
||||
|
||||
Or read the [documentation](https://github.com/aaru-dps/Aaru.Documentation/blob/master/5.0/README.md).
|
||||
Or read the [documentation](https://www.aaru.app).
|
||||
|
||||
Features
|
||||
========
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
subMaxLevel: 2,
|
||||
name: 'Aaru',
|
||||
repo: '',
|
||||
relativePath: true,
|
||||
themeable: {
|
||||
readyTransition: true, // default
|
||||
responsiveTables: true // default
|
||||
|
||||
Reference in New Issue
Block a user