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

docs: creating DEVELOPMENT.md and MAINTAINERS.md #1178

Open
sivasathyaseeelan opened this issue Jan 16, 2025 · 1 comment
Open

docs: creating DEVELOPMENT.md and MAINTAINERS.md #1178

sivasathyaseeelan opened this issue Jan 16, 2025 · 1 comment

Comments

@sivasathyaseeelan
Copy link
Contributor

DEVELOPMENT.md: This document will serve as a guide for new contributors to understand the project, including setup instructions, development workflows, coding standards, testing and guidelines for submitting changes.

MAINTAINERS.md: This document will list the maintainers, their roles, and contact methods, enabling new contributors to easily reach out with doubts or clarifications about the project.

@TorkelE
Copy link
Member

TorkelE commented Jan 16, 2025

If DEVELOPMENT.md is something standard, we could have a link to here, but https://docs.sciml.ai/Catalyst/dev/devdocs/dev_guide/ (to be expanded) is where we generally plan to have development stuff.

GitHub kind of has a maintainers list at https://github.com/SciML/Catalyst.jl/graphs/contributors, and I think the https://github.com/SciML/Catalyst.jl?tab=readme-ov-file#getting-help-or-getting-involved section on the main landing page is probably where we would want to have info regarding how to contact people.

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

No branches or pull requests

2 participants