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

Add developer guidelines #46

Merged
merged 2 commits into from
May 21, 2024
Merged

Add developer guidelines #46

merged 2 commits into from
May 21, 2024

Conversation

Sbozzolo
Copy link
Member

@Sbozzolo Sbozzolo commented May 18, 2024

Add guidelines on how to do testing/formatting/documentation/commits and replaces undocumented formatting infrastructure with one that is documented (but non standard across CliMA packages).

Closes #40
Closes #32
Closes #31

This reverts commit 12e22c0.
Copy link
Member

@AlexisRenchon AlexisRenchon left a comment

Choose a reason for hiding this comment

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

This is helpful, thanks!
I like having all tests in test, and use the extras deps, it is cleaner and easier. The README.md is well written and easy to understand, I just found one typo.

I have a suggestion, maybe for another PR: what do you think of having a NEWS.md file?

README.md Outdated Show resolved Hide resolved
@Sbozzolo Sbozzolo merged commit b616e05 into main May 21, 2024
6 checks passed
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 this pull request may close these issues.

Developer experience is not documented
2 participants