danparizher / Pax-Academia

General purpose utility bot for the Homework Help Discord server
MIT License
13 stars 5 forks source link

[Proposal] Docs: A new way to contribute code to Pax. #232

Closed sebastiaan-daniels closed 11 months ago

sebastiaan-daniels commented 1 year ago

Pax Academia started out as a small bot on the HwH discord server to fill in some gaps where small features were missing. Today, it is a complex project with an entire team working on it, serving more than 150 thousand users daily*.

At the moment, we have a group of code owners which each need to accept every pull request. Which is good for security, but bad for speed. Some dependencies and bugfixes simply need to be implemented faster, as our production deployment needs to be up to date and correct.

This new document aims to outline new guidelines and rules for contributing to this project. Focusing heavily on creating good, complete PRs which can be implemented quickly for smaller fixes, and thoroughly reviewed for bigger feats.

I highly recommend carefully reviewing this proposal, and sending your comments here on github instead of discord to keep discussion of this proposal (and potential implementation) grouped.

@\collaborators: Please do not add commits to this PR, use the comments/request changes instead.