Skip to content

Commit

Permalink
more content
Browse files Browse the repository at this point in the history
  • Loading branch information
pseyfert committed Jan 23, 2018
1 parent 224ddf1 commit 3ef5816
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 4 deletions.
40 changes: 40 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# title: A-CATCHY-TITLE-FOR-YOUR-PROJECT

## problem to solve

Give us some background. What are you wondering about? What unsolved question
do you want to shed light on? Which bug are you trying to fix / missing feature
to provide?

## desired outcome

What do you aim for?

- A pull request to a software project?
- A human readable document to document a workflow/ML method/an interface?
- A jupyter notebook?
- Having educated yourself, having tried a new tool?
- Having explored "what happens when I do X"? Something you always wanted to know but haven't found somebody else try.

## looking for know-how

Do you think you need an expert for your project? Would you profit from having an expert around who knows the internals of the TMVA Gui or scikit-learn's module structure?

## preparation

People who join your project might enjoy the project more if the come prepared.

Please keep the entry barrier low. It would be sad if only people who write
CUDA on a daily basis find satisfying projects.

Is there:

- a software one can install prior to the hackathon?
- a dataset to download?
- some initial questions to think about? a paper to read?

## further reading, anything else

Is there anything that doesn't fit any of the above?

You can edit the description of the pull request in the future.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,23 @@ feedback, make suggestions, etc.

## how to propose a project

Our Idea is to have projects submitted as pull requests, such that you can
discuss the project with interested participants through the discussion/review
functionality of pull requests.
Our Idea is to have projects submitted as pull requests. The actual content of
the pull request is not so important at this stage (just create a subdirectory
and put useful files inside) the main discussion and attraction of participants
should happen in the pull request discussion.

When creating a project please indicate:
There is a template for pull request descriptions in place, the general idea is to describe:

- What do you want to do? What is the project about?
- Will you work on the project yourself or is it a suggestion for somebody to pick up?
- What prerequesits should/could participants bring with them? / What kind of know-how are you lacking that ideally a participant would contribute (Maybe you want to add a functionality to your favourite ML library and it would be good to know your way around its source code?)
- Are there previous works to build upon? Is there something that can be prepared in advance (set up software installation / download dataset)?

## outcome

Whatever it is your project aims for (a study, a learning experience, a new
tool, a feature to an existing tool) we would be happy if you you can present
your achievement in one of the upcoming IML meetings.


<figure class=video_container">
Expand Down

0 comments on commit 3ef5816

Please sign in to comment.