chore: Add CONTRIBUTING.md, AUTHORS and DCO files
Signed-off-by: Awiteb <a@4rs.nl>
This commit is contained in:
1
AUTHORS
Normal file
1
AUTHORS
Normal file
@@ -0,0 +1 @@
|
|||||||
|
Awiteb <a@4rs.nl> (nprofile1qqsqqqqqq9g9uljgjfcyd6dm4fegk8em2yfz0c3qp3tc6mntkrrhawgpzfmhxue69uhkummnw3ezudrjwvhxumq3dg0ly)
|
||||||
86
CONTRIBUTING.md
Normal file
86
CONTRIBUTING.md
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
# Contributing to `n34`
|
||||||
|
|
||||||
|
For basic information about the `n34` project, please read the
|
||||||
|
[README.md](README.md). The project is licensed under **GPL-3.0**, and by
|
||||||
|
contributing, your work will also be licensed under the same terms.
|
||||||
|
|
||||||
|
Before submitting changes, please read the [Developer Certificate of Origin](DCO).
|
||||||
|
All patches must include a `Signed-off-by: NAME <EMAIL>` line to acknowledge
|
||||||
|
your agreement with the DCO.
|
||||||
|
|
||||||
|
We welcome all contributions, whether it be bug reports, fixes, feature
|
||||||
|
submissions, feature requests, or improving documentation or testing. Enjoy
|
||||||
|
collaborating!
|
||||||
|
|
||||||
|
## Git Repository
|
||||||
|
|
||||||
|
The repository is hosted at <https://git.4rs.nl/awiteb/n34.git>, with `master`
|
||||||
|
as the active development branch.
|
||||||
|
|
||||||
|
## Nostr Repository Address
|
||||||
|
|
||||||
|
You can submit issues and patches via any
|
||||||
|
Nostr-compatible client using the address:
|
||||||
|
`naddr1qqpkuve5qgsqqqqqq9g9uljgjfcyd6dm4fegk8em2yfz0c3qp3tc6mntkrrhawgrqsqqqaueq
|
||||||
|
yf8wumn8ghj7mn0wd68yt35wfejumnvqyxhwumn8ghj7mn0wvhxcmmvqy28wumn8ghj7mn0wd68ytn00
|
||||||
|
p68ytnyv4mqwuj6xc`
|
||||||
|
|
||||||
|
## Contribution Workflow
|
||||||
|
|
||||||
|
Before submitting changes, open an issue to discuss your proposed contribution.
|
||||||
|
Clearly indicate that you intend to work on it and wait for a maintainer's
|
||||||
|
response. If the issue remains open, you may proceed with submitting your patch.
|
||||||
|
|
||||||
|
### Reporting Issues
|
||||||
|
|
||||||
|
When opening an issue, include:
|
||||||
|
- Detailed steps to reproduce the problem
|
||||||
|
- Relevant error messages or logs (use the `-vvvv` flag for verbose output)
|
||||||
|
- Expected vs. actual behavior
|
||||||
|
|
||||||
|
Please label your issue appropriately (e.g., `bug`, `feature`, `question`) to
|
||||||
|
help categorize it.
|
||||||
|
|
||||||
|
### Your Patch
|
||||||
|
|
||||||
|
Ensure your patch submission tool notifies the maintainers and sends the patch
|
||||||
|
to their read relays, most tools handle this automatically.
|
||||||
|
|
||||||
|
#### Patch Guidelines
|
||||||
|
|
||||||
|
- Keep patches small: Focused changes are easier to review and merge.
|
||||||
|
- Use [Conventional Commits]: Start the patch subject with one of these types:
|
||||||
|
- `feat`: New feature
|
||||||
|
- `fix`: Bug fix
|
||||||
|
- `docs`: Documentation updates
|
||||||
|
- `refactor`: Code restructuring without behavioral changes
|
||||||
|
- `deprecate`: Marking code as deprecated
|
||||||
|
- `remove`: Removing deprecated code
|
||||||
|
- `security`: Security-related changes
|
||||||
|
- `perf`: Performance improvements
|
||||||
|
- `test`: Test additions or corrections
|
||||||
|
- For all other changes, use `chore`.
|
||||||
|
- Add `!` to the subject if your patch contains a breacking change, e.g.
|
||||||
|
`remove!: text` and `fix(reply)!: text`
|
||||||
|
- Run `just ci` before submitting your patch.
|
||||||
|
|
||||||
|
#### Code Style
|
||||||
|
|
||||||
|
When writing code, make sure to folow this:
|
||||||
|
- Using Rust's official formatting tool, `rustfmt`, to format your code.
|
||||||
|
- Writing clear and concise code with meaningful variable and function names.
|
||||||
|
- Adding comments to explain complex logic or algorithms.
|
||||||
|
|
||||||
|
#### Cover Letter Description
|
||||||
|
|
||||||
|
Your patch description should provide a clear and concise summary of the changes you
|
||||||
|
have made. It should also include any relevant context or background information
|
||||||
|
that will help the project maintainers understand the purpose of the changes.
|
||||||
|
Make sure to reference the issue[^1] that your patch is addressing, and note any breaking
|
||||||
|
changes that your patch introduces.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[^1]: When referencing, avoid URLs or `nevent` formats with relays. Instead, use only the note ID in `note1` bech32 format.
|
||||||
|
|
||||||
|
[Conventional Commits]: https://www.conventionalcommits.org/en/v1.0.0/
|
||||||
34
DCO
Normal file
34
DCO
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
Developer Certificate of Origin
|
||||||
|
Version 1.1
|
||||||
|
|
||||||
|
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
||||||
|
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies of this
|
||||||
|
license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
|
||||||
|
Developer's Certificate of Origin 1.1
|
||||||
|
|
||||||
|
By making a contribution to this project, I certify that:
|
||||||
|
|
||||||
|
(a) The contribution was created in whole or in part by me and I
|
||||||
|
have the right to submit it under the open source license
|
||||||
|
indicated in the file; or
|
||||||
|
|
||||||
|
(b) The contribution is based upon previous work that, to the best
|
||||||
|
of my knowledge, is covered under an appropriate open source
|
||||||
|
license and I have the right under that license to submit that
|
||||||
|
work with modifications, whether created in whole or in part
|
||||||
|
by me, under the same open source license (unless I am
|
||||||
|
permitted to submit under a different license), as indicated
|
||||||
|
in the file; or
|
||||||
|
|
||||||
|
(c) The contribution was provided directly to me by some other
|
||||||
|
person who certified (a), (b) or (c) and I have not modified
|
||||||
|
it.
|
||||||
|
|
||||||
|
(d) I understand and agree that this project and the contribution
|
||||||
|
are public and that a record of the contribution (including all
|
||||||
|
personal information I submit with it, including my sign-off) is
|
||||||
|
maintained indefinitely and may be redistributed consistent with
|
||||||
|
this project or the open source license(s) involved.
|
||||||
Reference in New Issue
Block a user