-
-
Notifications
You must be signed in to change notification settings - Fork 230
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
No contributing / developer docs #175
Comments
+1 I would like to contribute to this project. I have basic Python experience, but the setup to develop is opaque. Specifically, how do I set this project up to quickly modify, run, test? It seems to require a full install to run, so development is super slow. |
I agree that documentation is severely lacking. It's hard to find time to work on it. The quickest way to get started is to create a virtualenv and then run |
I see there is a new contributing guide added here: https://github.com/common-workflow-language/user_guide/blob/gh-pages/CONTRIBUTING.md I think it would be better if we have a common dev contrib guide in |
@manu-chroma Yes, that is an incompletely modified contributing guide inherited from https://github.com/swcarpentry/styles/ -- I agree that there should be a common contributing guide maintained in https://github.com/common-workflow-language/common-workflow-language and linked to from each project. |
I will use it as a base and add one soon |
Hey @manu-chroma I think details below can help anyone who wants to set up a virtual environment for the development purposes without messing up the original installations done on their systems: Notes from Code fest:To work for development purposes, you can install cwltool in a virtual environment:
|
Thanks @FarahZKhan @mr-c Wouldn't it make more sense to put the above instruction steps in a |
@manu-chroma You are welcome, and yes I think these are more tied to the python implementation cwltool so that might be a better place. |
The README appears to be end user focused and the Wiki is empty, so there doesn't appear to be any documentation on how to contribute to the project or to hack on the code.
I can figure out some of the dependencies by looking at the Makefile (e.g. pep8, pylint,
mypy), but explicit documentation on what developers need to install, what tests should be run before submitting PRs, etc would be useful.
Also, background documentation for things which might not be readily apparent to your garden variety Pythonista such was why it's a good thing to pretend to do static typing in a dynamically typed language, how to install
mypy
(since they don't appear to believe in installation instructions), etcThe text was updated successfully, but these errors were encountered: