Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge Contributing Guidelines with IOData Guidelines #2

Closed
PaulWAyers opened this issue Jun 12, 2024 · 1 comment · Fixed by #6
Closed

Merge Contributing Guidelines with IOData Guidelines #2

PaulWAyers opened this issue Jun 12, 2024 · 1 comment · Fixed by #6
Assignees

Comments

@PaulWAyers
Copy link
Member

We need to harmonize the contributing guidelines here with those from IOData.
https://github.com/tovrstra/iodata/blob/1032c13485a2dba0f8298617028145d806d5dc1d/CONTRIBUTING.rst

We should also, eventually, carefully document the development protocol (how to set up releases, GH actions, etc.) and harmonize it across repositories.

@tovrstra
Copy link
Member

The current contributing guide (in this repo) gives a good overview, and requires little technical background. That seems good, so I believe we should keep that format. I'd suggest adding more technical step-by-step instructions in different Markdown files, which can be referenced from the current contributing guide. I'll take a first stab at it after #4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants