diff options
author | sommerfeld <sommerfeld@sommerfeld.dev> | 2024-04-21 16:04:38 +0100 |
---|---|---|
committer | sommerfeld <sommerfeld@sommerfeld.dev> | 2024-04-21 16:04:38 +0100 |
commit | 1ab6ecba6f509b7b76865d65c77ecebc51efd2d3 (patch) | |
tree | a9b92e15769d483560d5799569b14c985b9c3ea5 /docs | |
download | sentrum-0.1.0.tar.gz sentrum-0.1.0.tar.bz2 sentrum-0.1.0.zip |
Initial commitv0.1.0
Diffstat (limited to 'docs')
-rw-r--r-- | docs/CHANGELOG.md | 3 | ||||
-rw-r--r-- | docs/CODE_OF_CONDUCT.md | 3 | ||||
-rw-r--r-- | docs/CONTRIBUTING.md | 27 | ||||
-rw-r--r-- | docs/SECURITY.md | 13 | ||||
-rw-r--r-- | docs/SUPPORT.md | 10 |
5 files changed, 56 insertions, 0 deletions
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 100644 index 0000000..009131d --- /dev/null +++ b/docs/CHANGELOG.md @@ -0,0 +1,3 @@ +0.1.0 (2024-04-21) +------------------ +Initial release diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..466b93b --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Code of Conduct + +Behave and say however you want, if your code is good, you will not be canceled. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..e2d58ea --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing + +## How to contribute + +1. Fork repo and create a new topic branch +2. Make changes +3. Ensure it compiles and passes tests using + +```bash +cargo build +cargo test +``` + +4. Auto format the code using `rustfmt` or a tool that integrates it (such as + `rust-analyzer` or some IDE). +5. Make small atomic compilable working commits. Do NOT use "Conventional + Commits" for the commit title. Instead just directly write what was changed +without any prefixes. Write it in the imperative tense and use the +["50/72" rule](https://stackoverflow.com/a/11993051) +6. Push commits to the created topic branch in your repo. +7. Open a PR, wait for review. + +## How to create a new Action + +Use the [telegram action](../src/actions/telegram.rs) as a template. You need to +implement the `Action` trait for your action and add the necessary hooks in +[actions/mod.rs](../src/actions/mod.rs). diff --git a/docs/SECURITY.md b/docs/SECURITY.md new file mode 100644 index 0000000..5586ce2 --- /dev/null +++ b/docs/SECURITY.md @@ -0,0 +1,13 @@ +# Security Policy + +## Supported Versions + +| Version | Supported | +| ------- | ------------------ | +| master | :white_check_mark: | +| < master | :x: | + +## Reporting a Vulnerability + +If you discover a serious vulnerability, +do not open an issue, instead contact the repository maintainer directly. diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md new file mode 100644 index 0000000..a497321 --- /dev/null +++ b/docs/SUPPORT.md @@ -0,0 +1,10 @@ +# Bitcoin + +## On-chain: + +* paynym: [+mistymud0Bf](https://paynym.is/+mistymud0Bf) +* [satsale sever](https://pay.sommerfeld.dev) + +## LN + +* Self-custodial lightning address: [sommerfeld@sommerfeld.dev](lightning:sommerfeld@sommerfeld.dev) |