Ecosystem/feather
Ecosystem/feather
1
0
Fork 0
mirror of https://github.com/feather-wallet/feather.git synced 2024-12-22 03:29:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update MAINTENANCE.md

Browse source
This commit is contained in:
tobtoht 2024-10-09 15:46:51 +02:00
parent 130432fd23
commit 2e91a0dc9f
No known key found for this signature in database
GPG key ID: E45B10DD027D2472
1 changed files with 23 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
MAINTENANCE.md
View file

@ -28,7 +28,19 @@ Goals:
Security issues that affect Feather always warrant a new release as soon as possible. Security issues that affect Feather always warrant a new release as soon as possible.
### 2. Reproducibility ### 2. Continuity
- Keep the website and services online
- Keep source repositories accessible
- Make sure that running release builds is easy to set up and reproducible in time
Goals:
- Make sure the project is transmissible
- Make sure that setting up release infrastructure, release engineering, and maintenance are extensively documented
- Make the websocket server repository public
### 3. Reproducibility
- Improve and maintain tools to check for non-determinism - Improve and maintain tools to check for non-determinism
- Ensure releases are reproducible and stay that way - Ensure releases are reproducible and stay that way
@ -40,32 +52,32 @@ To learn more about Feather's build system, see: [`contrib/guix/README.md`](http
Our Guix time-machine is currently pinned at a commit which implements the Our Guix time-machine is currently pinned at a commit which implements the
[Full-Source Bootstrap](https://guix.gnu.org/en/blog/2023/the-full-source-bootstrap-building-from-source-all-the-way-down/). [Full-Source Bootstrap](https://guix.gnu.org/en/blog/2023/the-full-source-bootstrap-building-from-source-all-the-way-down/).
### 3. Bugs ### 4. Bugs
- Fix bugs and crashes - Fix bugs and crashes
To report a bug, please see: https://docs.featherwallet.org/guides/report-an-issue To report a bug, please see: https://docs.featherwallet.org/guides/report-an-issue
### 4. Tests ### 5. Tests
- Improve test coverage - Improve test coverage
- Write more test cases - Write more test cases
Feather does not currently have a test suite (apart from the tests in the Monero submodule), this is a WIP. Feather does not currently have a test suite (apart from the tests in the Monero submodule), this is a WIP.
### 5. Documentation ### 6. Documentation
- Make sure the documentation accurately reflects the latest release - Make sure the documentation accurately reflects the latest release
- Add troubleshooting guides for common problems - Add troubleshooting guides for common problems
- Ideally, most support questions can be answered with a link to the documentation
Goals: Goals:
- Most support questions can be answered with a link to the documentation
- Reconsider and document default settings - Reconsider and document default settings
- Write a document on threat modeling - Write a document on threat modeling
Documentation is available at https://docs.featherwallet.org Documentation is available at https://docs.featherwallet.org
### 6. Improvements ### 7. Improvements
- Improve existing features - Improve existing features
- Improve UI/UX - Improve UI/UX
@ -73,7 +85,7 @@ Documentation is available at https://docs.featherwallet.org
Feather should first and foremost be a good __wallet__. Feather should first and foremost be a good __wallet__.
Improving features that are closer to this end should have priority. Improving features that are closer to this end should have priority.
### 7. Platform Support ### 8. Platform Support
- Add support for more architectures and operating systems - Add support for more architectures and operating systems
- Drop support for End-of-Life distributions - Drop support for End-of-Life distributions
@ -81,7 +93,7 @@ Improving features that are closer to this end should have priority.
See: https://docs.featherwallet.org/guides/supported-operating-systems See: https://docs.featherwallet.org/guides/supported-operating-systems
### 8. Optimization, cleanup and continuity ### 9. Optimization
Miscellaneous maintenance tasks. Miscellaneous maintenance tasks.
@ -99,9 +111,9 @@ Miscellaneous maintenance tasks.
Goals: Goals:
- Make sure Feather is ready for the migration to [Seraphis](https://github.com/seraphis-migration/wallet3) - Make sure Feather is ready for the migration to [FCMP++](https://www.getmonero.org/2024/04/27/fcmps.html)
### 9. Features ### 10. Features
- Implement new features - Implement new features
- Allow Feather to be used or configured for higher, esoteric or new threat models - Allow Feather to be used or configured for higher, esoteric or new threat models
@ -113,7 +125,7 @@ compared to its expected maintenance and support burden.
For a non-exhaustive list of potentially new features, see: https://featherwallet.org/ideas For a non-exhaustive list of potentially new features, see: https://featherwallet.org/ideas
### 10. Upstreaming ### 11. Upstreaming
- Upstream tried and tested features, bugfixes and useful patches - Upstream tried and tested features, bugfixes and useful patches
- Bugfixes should be upstreamed without delay - Bugfixes should be upstreamed without delay