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

Create a contributing.md for onboarding new developers #56

Open
putmantime opened this issue Apr 15, 2022 · 2 comments
Open

Create a contributing.md for onboarding new developers #56

putmantime opened this issue Apr 15, 2022 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@putmantime
Copy link
Contributor

Background:
We would like to lower the barrier for bringing on new monarch ingest developers and support standards around Monarch Ingest development

Acceptance Criteria:
Markdown documentation that details contribution to the source code.

Example: The existing Monarch UI contribution guide is a great example https://github.com/monarch-initiative/monarch-ui/blob/master/CONTRIBUTING.md

@putmantime putmantime added the documentation Improvements or additions to documentation label Apr 15, 2022
@glass-ships glass-ships self-assigned this Sep 1, 2022
@glass-ships
Copy link
Contributor

This page should also include helpful tips, like monarch-initiative/monarch-ingest#243

It's really helpful in poetry to have your virtual environment get created in a consistent place, so that the IDE always know where to point, even if you might want to clobber the environment and start over.
We could add a suggestion in our contributing.md about using
poetry config virtualenvs.in-project true

@sagehrke sagehrke transferred this issue from monarch-initiative/monarch-ingest Jan 17, 2024
@glass-ships
Copy link
Contributor

This may be redundant now that we have some more detailed documentation for monarch ingest.
@kevinschaper do you have thoughts on this?

@ptgolden ptgolden self-assigned this Sep 24, 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
No open projects
Status: Todo
Development

No branches or pull requests

3 participants