-
Notifications
You must be signed in to change notification settings - Fork 90
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 contributing guide to be more friendly #837
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #837 +/- ##
==========================================
- Coverage 73.88% 73.85% -0.04%
==========================================
Files 31 31
Lines 2003 2004 +1
==========================================
Hits 1480 1480
- Misses 523 524 +1 ☔ View full report in Codecov by Sentry. |
I expect we'll want to iterate quite a bit on language, but this should get the discussion going! |
Oh, and for #819, I have not done this:
Nor have I updated the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome work. I have some nitpicks! I don't feel the need to review again once they are addressed, but am happy to!
@@ -120,6 +120,8 @@ markdown_extensions: | |||
- pymdownx.inlinehilite | |||
- pymdownx.snippets | |||
- pymdownx.superfences | |||
- pymdownx.tabbed: | |||
alternate_style: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This option enables the content tabs alternate style, which has better behavior on mobile viewports, and is the only supported style
Then why isn't it the default 😆
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
¯\_(ツ)_/¯
Co-authored-by: Matt Fisher <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
👈 Launch a binder notebook on this branch for commit 93b59e8 I will automatically update this comment whenever this PR is modified |
earthaccess
documentation currently states that creating an issue is required before submitting a PR, which I think is an unnecessary barrier to many possible contributions. For example, it makes little sense to require an issue to fix a documentation spelling error. More discussion in slack here: https://openscapes.slack.com/archives/C05TMK269HA/p1726880090555649I've:
releasing.md
to exclusively use MkDocs style admonitions so they render well in ReadTheDocs (it had a mix of GitHub style and MkDocs style, and the GitHub style ones don't render well in our docs website)development.md
to improve the flowmkdocs build
does not have a--serve
option as suggested in the issue so we need to usemkdocs serve
--dirtyreload
option tomkdocs serve
has been renamed--dirty
scripts/docs-live.sh
as it's been replaced by noxscripts/build-docs.sh
as it appears to be unused and undocumented, but I did not add a nox session to build the docs since ReadTheDocs does that for us. It would be easy to add in however.pip
to be invoked in the preferred methodpython -m pip
, except the discussion ofpipx
b/c there you actually don't want your environment python to be invoked and instead use your system one (in reality this should be discussed more and I think this difference makes it maybe not suitable for the quickstart, but I'm leaving it for now).Pull Request (PR) draft checklist - click to expand
contributing documentation
before getting started.
Ensure an issue exists representing the problem being solved in this PR.<- no.title such as "Add testing details to the contributor section of the README".
Example PRs: #763
example
closes #1
. SeeGitHub docs - Linking a pull request to an issue.
CHANGELOG.md
with details about your change in a section titled## Unreleased
. If such a section does not exist, please create one. FollowCommon Changelog for your additions.
Example PRs: #763
README.md
with details of changes to theearthaccess interface, if any. Consider new environment variables, function names,
decorators, etc.
Click the "Ready for review" button at the bottom of the "Conversation" tab in GitHub
once these requirements are fulfilled. Don't worry if you see any test failures in
GitHub at this point!
Pull Request (PR) merge checklist - click to expand
Please do your best to complete these requirements! If you need help with any of these
requirements, you can ping the
@nsidc/earthaccess-support
team in a comment and wewill help you out!
Request containing "pre-commit.ci autofix" to automate this.
📚 Documentation preview 📚: https://earthaccess--837.org.readthedocs.build/en/837/