Instructions and expectations for contributors

[hypesystem]

Context & drivers

This repo and related repos may see contributions from a wide group of people. It should be easy for those potential contributors to navigate the process.

Tasks

• Add issue and PR templates for the repo and related repos, so it is clear what information we in the core team need to evaluate a change.
  • Concretely: motivation OR use cases OR bug reproduction; considered options and reasons for chosen option if applicable.
• Add CONTRIBUTING.md file documenting the expectations that contributors should have for the process
  • Concretely: follow issue/PR templates; be clear about motivation and provide use cases; remember to make sure changes can be extended in future; expect changes to be reviewed for technical merit, then discussed at a core team status meeting; be open to input that will help land the change.

[hypesystem]

@cableman @lasseborly Input on things I should cover in the files not mentioned here? Will give you some time to look here and consider it before I write up the full versions of the files.

[lasseborly]

I think keeping it lean and minimal is important to begin with. Your above thoughts is a fine start.

Templates should pref. not be checklists but questions that are important to us to have considered before submitting the issue or PR.

Then we should be using the CONTRIBUTING.md to cement the important design and security decisions for each component ex. for helm-deployments repo, we utilize sealed-secrets whenever possible.

[hypesystem]

From today's meeting: PR instructions for if you are creating a new release in helm-deployments: remember to link changelogs for all updated software versions.