omcproxy icon indicating copy to clipboard operation
omcproxy copied to clipboard
verified publisher icon openwrt

Add Contributing.md or other resource for potential contributors

Open jajik opened this issue 2 months ago • 2 comments

At the moment, there are several checks on commits that are not documented anywhere (?). It would be nice to list these requirements to prevent unnecessary confusion & CI failures.

Additionally, such a document would be a good place to mention code style guidelines (if any), etc.

jajik avatar Oct 23 '25 21:10 jajik

It might not be documented in this repo, but the same rules for general OpenWrt contributions still apply here: https://openwrt.org/submitting-patches

Noltari avatar Oct 25 '25 16:10 Noltari

Yes, this

https://github.com/openwrt/omcproxy/blob/11e45f6cfe105fb3bacc5c38face79f2aa619984/.github/workflows/formal.yml#L12

hints some general rules as well, but I wasn't aware of these tbh.

May I suggest adding a little section into the README.md? Something like

## Contributing

omcproxy is part of the OpenWrt Project, and as such, its contribution guidelines apply. You can find them [here](https://openwrt.org/submitting-patches).

jajik avatar Oct 25 '25 20:10 jajik