Skip to content
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 new Markdown assessment for READMEs #20

Open
avallecam opened this issue Nov 18, 2023 · 0 comments
Open

add new Markdown assessment for READMEs #20

avallecam opened this issue Nov 18, 2023 · 0 comments

Comments

@avallecam
Copy link
Member

Use a combination of behavioural and constructivist theory:

  • watch a motivational live demo on 'what I write is not what I see' with markdown
  • read a how-to guide on markdown for reporting issues or writing readmes on github
  • discuss in groups on the good practices and features applied to selected readme files
  • write an issue and a readme
    1. identify an existing readme that you read in the past and would like to improve (from you, your team, or a colleague)
    2. create an issue
    3. edit the file following your edit suggestions (then this will suggest you to fork, create a branch, make a pull request)
    4. share the pull request link in our discussion entry
@avallecam avallecam changed the title add new markdown assessment add new Markdown assessment for READMEs Nov 18, 2023
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

No branches or pull requests

1 participant