rustic-rs / dev-docs Goto Github PK
View Code? Open in Web Editor NEWrustic dev documentation
Home Page: http://rustic.cli.rs/dev-docs/
License: Mozilla Public License 2.0
rustic dev documentation
Home Page: http://rustic.cli.rs/dev-docs/
License: Mozilla Public License 2.0
I think it would be nice to package the book with rustic
like we do with the config/
directory. For that it would be essential to be able to render the book to pdf and/or epub or some other format that can be viewed by the users without installing a special reader for it.
Should be describing certain architectural decisions and giving a graphical overview.
One of the lessons I’ve learned is that the biggest difference between an occasional contributor and a core developer lies in the knowledge about the physical architecture of the project. Roughly, it takes 2x more time to write a patch if you are unfamiliar with the project, but it takes 10x more time to figure out where you should change the code. This difference might be hard to perceive if you’ve been working with the project for a while.
I find the ARCHITECTURE file to be a low-effort high-leverage way to bridge this gap. As the name suggests, this file should describe the high-level architecture of the project. Keep it short: every recurring contributor will have to read it. Additionally, the shorter it is, the less likely it will be invalidated by some future change. This is the main rule of thumb for ARCHITECTURE — only specify things that are unlikely to frequently change. Don’t try to keep it synchronized with code. Instead, revisit it a couple of times a year.
where’s the thing that does X?
what does the thing that I am looking at do?
https://matklad.github.io/2021/02/06/ARCHITECTURE.md.html
Examples:
This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.
These branches will be created by Renovate only once you click their checkbox below.
These updates have all been created already. Click a checkbox below to force a retry/rebase of any.
.github/workflows/install-mdbook/action.yml
taiki-e/install-action v2
.github/workflows/lint-md.yml
actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
dprint/check v2.2@2f1cf31537886c3bfb05591c031f7744e48ba8a1
.github/workflows/mdbook.yml
actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
actions/configure-pages v4@1f0c5cde4bc74cd7e1254d0cb4de8d49e9068c7d
actions/upload-pages-artifact v3@56afc609e74202658d3ffba0e8f6dda462b719fa
actions/deploy-pages v4@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e
.github/workflows/url-check-on-change.yml
actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
gaurav-nelson/github-action-markdown-link-check v1@5c5dfc0ac2e225883c0e5f03a85311ec2830d368
.github/workflows/url-check-periodic.yml
actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
gaurav-nelson/github-action-markdown-link-check v1@5c5dfc0ac2e225883c0e5f03a85311ec2830d368
The docs are outdated WRT the release process. They need to be updated also for the release PR usage and there should be a checklist to follow.
Read and work in feedback: https://diataxis.fr/
Currently, this is being empty: https://github.com/rustic-rs/rustic/blob/main/docs/dev/development_guide.md
As a starter, we should explain the following things:
just
for common commands (#820)cargo xtask
for coverage reports and installing needed dependencies (#820)VSCodium
) for Rust developmentA declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.