diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..41dd22dbd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +## Contributing code the right way + +*or: how I learned to post merge requests without crying myself to sleep* + +1. Post your idea on the forums, ask to be given developer privileges. Preferably post diffs if you got them. Don't forget to mention your gitlab username. I think it's now possible to request project access but not sure -fox. +2. When you have developer privileges you can make branches, check them out, work on them locally, push them back and post merge requests. +3. Usual stuff applies: don't post unrelated issues in one merge request, try to not screw up indenting (tt-rss mostly uses tab characters), try to respect surrounding formatting style, etc. +4. That's it.