To better encourage and manage user-submitted contributions like new methods and custom callbacks, we should add both a contribution guide walking through the process as well as code of conduct to set expectations.
Contribution guide can be a markdown file with a small example, say a custom callback. It should walk a user through the steps of integrating this feature into barmpy. Namely:
Fork/branch with a single new feature implemented and unit test created (if applicable).
Pull request created describing contribution.
Review by one of the barmpy maintainers
Possible revisions.
Merging complete features.
As a practical matter, features added by the primary developers (i.e. Dr. Van Boxel) will likely continue on the main branch directly for now.
The code of conduct can be a short statement, likely as part of the contribution guide, asserting how to engage with the barmpy community. We can pull some examples from https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project, but the short answer will be treating people with respect, understanding that different opinions can exist, and keeping discussion within barmpy focused on the development of this project (i.e. not wider mathematical discussion, however fun that may be).
To better encourage and manage user-submitted contributions like new methods and custom callbacks, we should add both a contribution guide walking through the process as well as code of conduct to set expectations.
Contribution guide can be a markdown file with a small example, say a custom callback. It should walk a user through the steps of integrating this feature into
barmpy. Namely:barmpymaintainersAs a practical matter, features added by the primary developers (i.e. Dr. Van Boxel) will likely continue on the
mainbranch directly for now.The code of conduct can be a short statement, likely as part of the contribution guide, asserting how to engage with the
barmpycommunity. We can pull some examples from https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project, but the short answer will be treating people with respect, understanding that different opinions can exist, and keeping discussion withinbarmpyfocused on the development of this project (i.e. not wider mathematical discussion, however fun that may be).