Skip to content

Commit 8ebae93

Browse files
committedApr 8, 2025··
Add plainx to CONTRIBUTING.md
1 parent 7a30a91 commit 8ebae93

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed
 

‎CONTRIBUTING.md

+8
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,11 @@
33
First of all, there's more than one way to contribute to Plain. [Sharing the project on social media](https://x.com/plainframework), or [starring it on GitHub](https://github.com/dropseed/plain), are surprisingly helpful things that anyone can do!
44

55
For more technical contributions, please [open an issue for well-identified bugs](https://github.com/dropseed/plain/issues), and a [discussion for anything else](https://github.com/dropseed/plain/discussions). Don't waste your time working on a lengthy PR with the _hope_ that it will be merged! Writing the code is often the easy part — deciding how to do something, or whether to do it at all, is harder and more important.
6+
7+
## PlainX Community Packages
8+
9+
There will be a number of things that we don't want to officially maintain and support, especially when it comes to integrations with commercial SaaS services — these are best left to the vendor themselves, or a community member who wants to run with it. When in doubt, just [open a discussion and ask](https://github.com/dropseed/plain/discussions).
10+
11+
If you want to develop your own package that works with Plain, you should use the `plainx` community namespace. Like `plain`, the `plainx` prefix intended to be a [PEP 420 "implicit namespace"](https://peps.python.org/pep-0420/) — this just means that you can put your code in `plainx/{custom}` and it can be imported as `plainx.{custom}`. For this to work, the only thing you really need to know is that you should _not_ have a `plainx/__init__.py` file in your source.
12+
13+
There are also plenty of things that don't warrant an entire package! Copy and paste is encouraged. If you have a single-file solution to a common problem and want to share it, email support@plainframework.com about ways we can help.

0 commit comments

Comments
 (0)
Please sign in to comment.