mirror of https://github.com/razor-ai/soup.git
docs: add the Discord server and split the project and personal contacts
Discord is added as a fourth community channel, with the boundary stated rather than left to guesswork: it is for live chat and setup help, while anything that should still be findable in six months belongs in Issues or Discussions. A Discord answer helps one person; an issue helps everyone who hits the same thing, and the repository already routes public traffic that way. It lands in the four places a reader actually looks - the README header, the badge row, the Contact section, and CONTRIBUTING's Community list - plus `[project.urls]`, which is the one that matters most in practice: most users arrive from PyPI, whose sidebar previously showed only Homepage, Repository and Issues. That entry is metadata and takes effect on the next publish. Both a Code of Conduct that does not name the server and a security policy that does not exclude it are gaps a public chat channel creates, so the Code of Conduct now states it applies there, and SECURITY.md says explicitly not to report vulnerabilities in a public channel. The single maintainer address becomes two with distinct roles, because one address doing both jobs cannot be handed over: team@trysoup.dev is the project address and survives a change of maintainer, while makazanalpamys@gmail.com stays as the personal fallback. Both are listed everywhere a contact appears - README, SECURITY.md, CODE_OF_CONDUCT.md - and pyproject's author email, which PyPI renders as the package contact, moves to the project address. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
Alpamys
parent
2bf714bec8
commit
fba981595b
|
|
@ -36,7 +36,9 @@ This Code of Conduct applies within all community spaces, and also applies when
|
|||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainer at **makazanalpamys@gmail.com**. All complaints will be reviewed and investigated promptly and fairly.
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainer at **team@trysoup.dev** (the project address) or **makazanalpamys@gmail.com** (the maintainer's personal address). All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
This Code of Conduct applies in every project space, including the [Discord server](https://discord.gg/hnZjaDa4w).
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
|
||||
|
||||
|
|
|
|||
|
|
@ -459,8 +459,10 @@ If you contributed and aren't credited somewhere, that's a bug — open a PR or
|
|||
|
||||
- **Issues:** Report bugs and request features on [GitHub Issues](https://github.com/MakazhanAlpamys/Soup/issues)
|
||||
- **Discussions:** Ask questions on [GitHub Discussions](https://github.com/MakazhanAlpamys/Soup/discussions)
|
||||
- **Code of Conduct:** Please read [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
|
||||
- **Security:** Report security issues via [SECURITY.md](SECURITY.md)
|
||||
- **Discord:** Chat with maintainers and other users on [Discord](https://discord.gg/hnZjaDa4w) — good for
|
||||
quick questions and pairing on a PR; anything worth finding later still belongs in Issues or Discussions
|
||||
- **Code of Conduct:** Please read [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) — it applies on Discord too
|
||||
- **Security:** Report security issues via [SECURITY.md](SECURITY.md) — privately, never in Discord
|
||||
|
||||
## Questions?
|
||||
|
||||
|
|
|
|||
13
README.md
13
README.md
|
|
@ -14,7 +14,8 @@
|
|||
<a href="#configuration">Config</a> ·
|
||||
<a href="#documentation">Docs</a> ·
|
||||
<a href="docs/commands.md">Commands</a> ·
|
||||
<a href="docs/models.md">Models</a>
|
||||
<a href="docs/models.md">Models</a> ·
|
||||
<a href="https://discord.gg/hnZjaDa4w">Discord</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
|
|
@ -25,6 +26,7 @@
|
|||
<a href="https://github.com/MakazhanAlpamys/Soup/actions"><img src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/MakazhanAlpamys/65fdc943f85f3b2c46ecddb415c2b779/raw/soup_tests.json" alt="Tests"></a>
|
||||
<a href="https://github.com/MakazhanAlpamys/Soup/actions"><img src="https://github.com/MakazhanAlpamys/Soup/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
|
||||
<a href="https://trysoup.dev"><img src="https://img.shields.io/badge/website-trysoup.dev-blue" alt="Website"></a>
|
||||
<a href="https://discord.gg/hnZjaDa4w"><img src="https://img.shields.io/badge/Discord-join-5865F2?logo=discord&logoColor=white" alt="Discord"></a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
|
@ -382,8 +384,15 @@ Bugs and feature requests belong in the
|
|||
[Discussions](https://github.com/MakazhanAlpamys/Soup/discussions) — both get answered faster
|
||||
and help the next person with the same problem.
|
||||
|
||||
For live chat, setup help, and everything that reads better as a conversation, join the
|
||||
[Discord](https://discord.gg/hnZjaDa4w). Anything that should still be findable in six months
|
||||
belongs in Issues or Discussions — a Discord answer helps one person, an issue helps everyone
|
||||
who hits the same thing. The [Code of Conduct](CODE_OF_CONDUCT.md) applies there too.
|
||||
|
||||
For anything that does not fit in public — security reports (see [SECURITY.md](SECURITY.md)),
|
||||
Code of Conduct matters, or press — email **makazanalpamys@gmail.com**.
|
||||
Code of Conduct matters, or press — email **team@trysoup.dev**. That is the project address
|
||||
and the right one for anything Soup-related. **makazanalpamys@gmail.com** is the maintainer's
|
||||
personal address; it reaches the same person and is a fine fallback.
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,9 @@ for anything security-sensitive.
|
|||
|
||||
- Preferred: open a private report via
|
||||
[GitHub Security Advisories](https://github.com/MakazhanAlpamys/Soup/security/advisories/new).
|
||||
- If you cannot use GitHub, email the maintainer at **makazanalpamys@gmail.com**.
|
||||
- If you cannot use GitHub, email **team@trysoup.dev** (the project address), or
|
||||
**makazanalpamys@gmail.com** (the maintainer's personal address) if that bounces.
|
||||
Please do not report security issues in Discord — it is a public channel.
|
||||
|
||||
We aim to acknowledge reports within 5 business days and to ship a fix or
|
||||
mitigation for confirmed, in-scope issues as promptly as is practical. When
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ readme = "README.md"
|
|||
license = "Apache-2.0"
|
||||
requires-python = ">=3.10"
|
||||
authors = [
|
||||
{ name = "Soup Team", email = "makazanalpamys@gmail.com" },
|
||||
{ name = "Soup Team", email = "team@trysoup.dev" },
|
||||
]
|
||||
keywords = ["llm", "fine-tuning", "lora", "qlora", "machine-learning"]
|
||||
classifiers = [
|
||||
|
|
@ -121,6 +121,7 @@ soup = "soup_cli.cli:run"
|
|||
Homepage = "https://github.com/MakazhanAlpamys/Soup"
|
||||
Repository = "https://github.com/MakazhanAlpamys/Soup"
|
||||
Issues = "https://github.com/MakazhanAlpamys/Soup/issues"
|
||||
Discord = "https://discord.gg/hnZjaDa4w"
|
||||
|
||||
[tool.hatch.build.targets.wheel]
|
||||
packages = ["src/soup_cli"]
|
||||
|
|
|
|||
Loading…
Reference in New Issue