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

gh-185: update CONTRIBUTING.md (developer guide) #255

Merged
merged 3 commits into from
Sep 26, 2024

Conversation

Saransh-cpp
Copy link
Member

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

@Saransh-cpp Saransh-cpp added the documentation Improvements or additions to documentation label Sep 19, 2024
@paddyroddy paddyroddy self-requested a review September 25, 2024 13:17
Copy link
Member

@paddyroddy paddyroddy left a 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 Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated
following way -

```bash
python -m pytest --cov=glass --doctest-plus -v
Copy link
Member

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

Copy link
Member Author

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.

Copy link
Member

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

Copy link
Member Author

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.

Copy link
Member

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

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@paddyroddy paddyroddy left a comment

Choose a reason for hiding this comment

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

Looks nice

@Saransh-cpp Saransh-cpp merged commit 35ebdea into main Sep 26, 2024
10 checks passed
@Saransh-cpp Saransh-cpp deleted the saransh/developer-guide branch September 26, 2024 09:04
@Saransh-cpp Saransh-cpp self-assigned this Sep 27, 2024
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.

Add developer documentation
2 participants