From 3722c34e4d0210bb82bb448130ead6ab8b232411 Mon Sep 17 00:00:00 2001 From: verdant Date: Mon, 3 Aug 2026 22:07:42 +0800 Subject: Add contributing guide --- CONTRIBUTING.md | 17 +++++++++++++++++ README.md | 4 ++++ 2 files changed, 21 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..605f48a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing + +Thanks for your interest in contributing to Sf. Bug reports, feature requests, documentation improvements and code changes are welcome. This project is hosted on SourceHut, but we accept both GitHub Pull Requests and git patches. Please ensure your commits match our `.clang-format`. All PRs will be reviewed and applied locally via `git am`. + +## Bug Reporting + +Send an email to `~verdant/sf-devel@lists.sr.ht` if no matching report exists. You can also submit reports via the [web interface](https://lists.sr.ht/~verdant/sf-devel). + +Please describe the issue as clearly as possible and include complete execution logs. + +## Code changing + +Before submitting a patch or creating a Pull Request, we encourage you to send an email to the mailing list for discussion first. + +## AI Policy + +`sf` **\*DOES NOT\*** accept any contribution by AI. All patches, PRs and discussion descriptions must be written by humans, not by AI. You must fully understand all the code you submit. No one will take responsibility for AI-generated code. diff --git a/README.md b/README.md index f94e006..d2b9119 100644 --- a/README.md +++ b/README.md @@ -17,3 +17,7 @@ Dependencies: ```bash $ sudo make install ``` + +## Contributing + +Contributions are welcome, please see the [CONTRIBUTING.md](./CONTRIBUTING.md). -- cgit v1.2.3