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

Update README.md to point to xdem instead of geoutils #412

Merged
merged 1 commit into from
Aug 22, 2023

Conversation

erikmannerfelt
Copy link
Contributor

In the end of the README, it states to push a feature branch to geoutils:main which is obviously wrong.

@erikmannerfelt erikmannerfelt added the documentation Improvements or additions to documentation label Aug 21, 2023
@rhugonnet
Copy link
Contributor

Strange test failure, I restarted all CI runs!

For the "Contributing" file + README summary, I shortened it earlier this year to avoid repetition with other files (License, Install, etc) and keep it simple. But I now find it a bit "formal" (not too inviting)... What do you think?

I was thinking we could take some ideas from pyproj, which has a very inviting page (a bit too long to read to my taste, maybe we could mostly work on our intro, then keep our "Short" summary for experienced developers and add a "Long" one for new developers?): https://github.com/pyproj4/pyproj/blob/main/CONTRIBUTING.md
I also really like the effort to recognize contributors on the front page: https://github.com/pyproj4/pyproj#contributors-

@erikmannerfelt erikmannerfelt merged commit 05a4702 into main Aug 22, 2023
13 checks passed
@erikmannerfelt erikmannerfelt deleted the update-readme-gu-to-xdem branch August 22, 2023 08:38
@erikmannerfelt
Copy link
Contributor Author

Strange test failure, I restarted all CI runs!

For the "Contributing" file + README summary, I shortened it earlier this year to avoid repetition with other files (License, Install, etc) and keep it simple. But I now find it a bit "formal" (not too inviting)... What do you think?

I was thinking we could take some ideas from pyproj, which has a very inviting page (a bit too long to read to my taste, maybe we could mostly work on our intro, then keep our "Short" summary for experienced developers and add a "Long" one for new developers?): https://github.com/pyproj4/pyproj/blob/main/CONTRIBUTING.md I also really like the effort to recognize contributors on the front page: https://github.com/pyproj4/pyproj#contributors-

That's good to make it as inviting as we can!

I also like the sentiment of attributing the contributors more (especially not us haha). As long as it's autonomous or at least validated, I'm all for it! Without validation, I think we'd easily fall behind when new contributors appear.

Mind making these into one or two issues?

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

Successfully merging this pull request may close these issues.

2 participants