-
Notifications
You must be signed in to change notification settings - Fork 8
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
gh-185: update CONTRIBUTING.md (developer guide) #255
Conversation
36c8a10
to
eb7586c
Compare
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.
Thanks for doing this! Various suggestions
CONTRIBUTING.md
Outdated
following way - | ||
|
||
```bash | ||
python -m pytest --cov=glass --doctest-plus -v |
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.
For another PR, but we can configure the coverage in pyproject.toml
so one doesn't need to explicitly write --cov=glass
. https://github.com/astro-informatics/sleplet/blob/782279ec1be404aa356c6e0b583bd536cf3a4789/pyproject.toml#L101-L109
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.
Added -v
in the recent PR. I usually avoid adding the cov
and the doctest-plus
option in pyproject.toml because we don't need those always.
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.
I agree, my suggestion is you add to it the coverage
section. So when you ask for coverage you get it on glass
without having to specify it - I'm not asking for the pytest
section
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.
Ahh, let me quickly check that.
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.
Don't worry we can fix in another issue #282
e655959
to
de49684
Compare
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.
Looks nice
de49684
to
c113d3c
Compare
I have updated the contributing guideline to reflect all the recent changes. I think keeping it just on GitHub should be okay, given that the new developers will look at the GitHub repository before contributing.
Closes: #185