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

Edit tasks section of the README #40

Open
Cleop opened this issue Mar 30, 2017 · 2 comments
Open

Edit tasks section of the README #40

Cleop opened this issue Mar 30, 2017 · 2 comments
Assignees
Labels
enhancement New feature or enhancement of existing functionality in-progress An issue or pull request that is being worked on by the assigned person

Comments

@Cleop
Copy link
Member

Cleop commented Mar 30, 2017

After reading dwyl/contributing#4 about raising issues for every PR, I am creating this issue because I intend to work through the exercise on the README and then submit any amends based on my experience.

@Cleop Cleop added the enhancement New feature or enhancement of existing functionality label Mar 30, 2017
@Cleop Cleop self-assigned this Mar 30, 2017
@Cleop
Copy link
Member Author

Cleop commented Mar 30, 2017

  • Think about order/ route of someone's learning based on resources suggested.
    Ie. Elixir School, our exercises, videos etc.
  • Add line about what the README will teach you. Ie. introduce you to basic types and then run your through project set up and some basic examples. This will help readers gauge whether the README is at the right experience level for them and whether it's going to help them achieve what they're setting out to achieve.

@Cleop Cleop added the in-progress An issue or pull request that is being worked on by the assigned person label Mar 31, 2017
@Cleop
Copy link
Member Author

Cleop commented Mar 31, 2017

  • Add a note that correct documentation will show a user how to correctly run the function. I skimmed this and got confused when implementing randomise!

  • Explain basic error messages? Like:

image

Ie. that the randomise functions expects to receive 1 argument.

  • Etiquette for documenting functions, the examples have documentation but it might be helpful to have a note saying, you should always write documentation before creating a function or devs tend to do documentation in batches or whatever the correct etiquette is!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or enhancement of existing functionality in-progress An issue or pull request that is being worked on by the assigned person
Projects
None yet
Development

No branches or pull requests

1 participant