-
Notifications
You must be signed in to change notification settings - Fork 72
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
Add CONTRIBUTING.md. #464
Add CONTRIBUTING.md. #464
Conversation
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 taking the initiative on this! Can you put the text into a Google doc? I think we will need to draft this a bit before merging.
That is a good point; I will share the Google doc with you. |
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.
Thank you for writing this up. A lot of good info here, particularly for newer devs who may not be familiar with github workflows.
I think we still need a few more sections for some steps that we typically go through before putting up a PR.
For WDL updates,
- Updating corresponding template and inputs jsons in
/inputs
- Rebuilding inputs with
build_default_inputs.sh
as described in the README - Validating with womtool and miniwdl using the scripts in
/scripts/test
- Performing a test run on Terra (standalone Cromwell servers are to be deprecated soon)
- Information on updating the Terra workspace configurations would also be useful
For backend code (i.e. mostly stuff in /src
and /dockerfiles
:
- Rebuilding and pushing the docker with
build_docker.py
- Running a test in Terra
- Updating dockers.json and dockers_azure.json if necessary, i.e. when it's not an auto-built docker
This is getting to be a long list, so maybe these belong on the website as a part of development documentation, but if we are going to expect users to actually commit changes and post PRs, they will need the rest of this information to get to that point.
|
||
You may open the code base in any text editor or integrated development environment (IDE). | ||
We recommend using [PyCharm](https://www.jetbrains.com/pycharm/) or | ||
[Visual Studio](https://visualstudio.microsoft.com/vs/community/), |
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.
Does VS have a WDL plugin? If not we may want to just suggest pycharm.
Co-authored-by: Mark Walker <[email protected]>
Co-authored-by: Mark Walker <[email protected]>
Co-authored-by: Mark Walker <[email protected]>
Co-authored-by: Mark Walker <[email protected]>
Co-authored-by: Mark Walker <[email protected]>
Co-authored-by: Mark Walker <[email protected]>
Co-authored-by: Mark Walker <[email protected]>
Co-authored-by: Mark Walker <[email protected]>
Co-authored-by: Mark Walker <[email protected]>
Co-authored-by: Mark Walker <[email protected]>
Co-authored-by: Mark Walker <[email protected]>
Co-authored-by: Mark Walker <[email protected]>
Co-authored-by: Mark Walker <[email protected]>
Co-authored-by: Mark Walker <[email protected]>
Thanks, @mwalker174! Those points are all great; we can extend this contributing file or add a section to the docs to explain these steps in detail. |
This PR adds the
contributing.md
that includes guidelines on code contribution and bug reporting.