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

Documentation for working of the project #28

Open
garimasingh128 opened this issue Aug 15, 2020 · 2 comments
Open

Documentation for working of the project #28

garimasingh128 opened this issue Aug 15, 2020 · 2 comments
Labels
CH20 Documentation Improvements or additions to documentation Easy Hacktoberfest Counting contributions for Hacktoberfest

Comments

@garimasingh128
Copy link
Owner

  • An md file to be created to add the workflow and how the project works generally.
  • This should be a beginner friendly document so that they should know how things are working behind the scenes
  • Make it interactive with emojis, images and memes
  • For ex: Suppose in a DisplayCard.js we have used Github apis so you should write in a layman's language in the document about their working and how they function. Then move on to the technical aspects like the API calling and parameters.
  • Naming convention: WORKFLOW.md
@garimasingh128 garimasingh128 added Documentation Improvements or additions to documentation CH20 Easy labels Aug 15, 2020
@harshareddy794
Copy link

can I work on this issue @garimasingh128

@harshareddy794
Copy link

Thanks @garimasingh128

@garimasingh128 garimasingh128 added the Hacktoberfest Counting contributions for Hacktoberfest label Sep 22, 2020
@harshareddy794 harshareddy794 removed their assignment Oct 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CH20 Documentation Improvements or additions to documentation Easy Hacktoberfest Counting contributions for Hacktoberfest
Projects
None yet
Development

No branches or pull requests

2 participants