Skip to content

Initial PR template#80

Merged
maybeec merged 1 commit intodevonfw-tutorials:mainfrom
SchettlerKoehler:feature/pr-template
Apr 3, 2021
Merged

Initial PR template#80
maybeec merged 1 commit intodevonfw-tutorials:mainfrom
SchettlerKoehler:feature/pr-template

Conversation

@SchettlerKoehler
Copy link
Copy Markdown
Collaborator

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 2, 2021

Thanks for submitting your work on a (new) tutorial!

Some suggestions, which might help:

  • Title: Focus on what you want to train in a few words. Don't be too generic
  • Tutorial:
    • Address the user directly.
    • Explain why the steps are necessary.
    • Explain what are the results and why are they necessary for your next step.
    • Forward the user to more elaborate documentation on the website (deep links) for further reading

Also please find further help for creating tutorials here or more help regarding the tutorial syntax here.

You can view the generated tutorials of this PR here in a few minutes. You just have to wait for the run of the deployment action to finish.

When you think you are done writing the tutorial try the tutorial on the deveplopment area and check if you explained every step in a way someone who is trying to learn what you are teaching can understand. Ideally ask someone to have a look on what you have done and have that part double checked because this is very important.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 2, 2021

@maybeec maybeec merged commit 8273678 into devonfw-tutorials:main Apr 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants