Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

45 lines (33 loc) · 1.74 KB
Raw

Contributing

Contributions are very welcome, and credit will always be given!

Templating

scilaunch is a wrapper around the template engine cookiecutter. That means, that the development of scilaunch is closely related to the development of the template research-project.

To build your own templates, check out the cookiecutter docs. Feel free to fork & adapt the research-project template. It is planned to optionally use other research-related templates in the future as well.

Setup for development

Fork &/or clone the repo:

git clone https://github.com/SHEscher/scilaunch.git

Install the dependencies for development, ideally in a virtual environment in editable mode:

cd scilaunch
pip install -e ".[develop,docs]"

At this stage, the project is small. Contributions via pull requests are welcome. A more comprehensive contribution guide will be added in the future, in case the project grows.

Future directions & ToDo's

  • extend docs/
    • add brief information & recommendations to docs for all options to choose from
    • create tutorial videos
  • allow passing other cookiecutter templates
  • optional: implement scilaunch example --remove or so to remove example files
  • add files in /.github/ISSUE_TEMPLATE/
  • midterm ideas: scilaunch methods after project is initialized, e.g.:
    • project specific .scilaunch file to save project settings
    • scilaunch add e.g. LICENSE (runs only LICENSE template)
    • scilaunch docs create docs website
    • ...