Skip to content

Conversation

@jbreue16
Copy link
Contributor

@jbreue16 jbreue16 commented Oct 24, 2025

@schmoelder schmoelder changed the title Update README.md Update contributor's guide Oct 24, 2025
jbreue16 and others added 2 commits October 24, 2025 13:42
Co-authored-by: Johannes Schmölder <[email protected]>
Co-authored-by: Johannes Schmölder <[email protected]>
@schmoelder
Copy link
Contributor

Generally looks good. Should we start tracking the individual tasks from the (e.g. linting / auto-formatting) here or make separate issues?

See also #404

@jbreue16
Copy link
Contributor Author

I think the linting, formatting is an issue on its own, ive added a todo to add this to the contributing.md in #404. The rest is already in place and the contributing.md only links to where more detailed descriptions can be found.

@schmoelder
Copy link
Contributor

schmoelder commented Oct 24, 2025

Gotcha. For reference, here is the CADET-Process Contributor's guide. I'm quite happy with how it turned out. But note, we don't have a real developer's guide so it has double duty here.

But I'm also not entirely sure yet where exactly the difference (although there certainly is one).

Reorganize sections for clarity and update branch policy details.
@jbreue16
Copy link
Contributor Author

Thanks! Ive added the PR vs issue and branch policy sections. The rest is either already documented in the dev-guide (and i want to avoid repetition), or missing (formatting, pre-commit).

@jbreue16 jbreue16 merged commit 0169d54 into master Oct 24, 2025
1 check passed
@jbreue16 jbreue16 deleted the doc/contributing branch October 24, 2025 11:59
@github-actions github-actions bot locked and limited conversation to collaborators Oct 24, 2025
Copy link
Member

@lieres lieres left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider mentioning "private" mail to [email protected] as additional contact option.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants