Skip to content
This repository has been archived by the owner on Mar 2, 2024. It is now read-only.

Add contributor guide #267

Open
berendt opened this issue Oct 11, 2021 · 2 comments
Open

Add contributor guide #267

berendt opened this issue Oct 11, 2021 · 2 comments
Labels
enhancement New feature or request

Comments

@berendt
Copy link
Member

berendt commented Oct 11, 2021

We need a chapter on how to make contributions with us.

GitHub workflow, commit messages, central repository for issues, ...

@berendt
Copy link
Member Author

berendt commented Oct 11, 2021

@linwalth Can you please list what you would find useful?

The Contributor Guide here is independent of the Contributor Guide for SCS.

@berendt berendt added the enhancement New feature or request label Oct 11, 2021
@linwalth
Copy link

It would be nice to have a link to a prominent page where the different projects/repos of which OSISM is comprised and the way they work together are explained. - Maybe a small diagram, too.

Right now it is a bit complex and takes a lot of time to grasp what OSISM does "under the hood" and which things are connected and influence each other. To see which depends on what and where would be really helpful to get in the project.

I know that this is more of a "meta" objective but for someone who wants to contribute it is important to quickly get a grasp of the infrastructure.

Another non-meta thing which we think would be important is a list of goals and non-goals of the project to quickly make understood how generic/specific contributions have to be.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants