codeuino/codebadge-backend

Document CodeBadge Features

Opened this issue · 0 comments

shivamluthra commented

What you will need to know?

Communication & Presentation Skills - Beginner level

Document CodeBadge Features

CodeBadge will be a newly created platform to Codeuino and all of its features and setup instructions need to be documented well in order to facilitate the usability. You'll need to follow up with other contributors/maintainers of CodeBadge as well as thoroughly go through the complete code base and document everything in Markdown format under 'CodeBadge Docs' section(a new section that'll be created by you) on Codeuino Docs.

Requirements

  • Communication & Presentation Skills - Beginner level

Steps to Follow

  • Claim this issue: Comment below. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!
  • Install CodeBadge on your system go through readme.md in development branch for this purpose
  • After installing CodeBadge install dependencies of backend and frontend, go through readme.md inside both the folders
    Link to readme https://github.com/codeuino/Codebadge/blob/master/README.md
  • To run the project follow the given step in readme.md for both frontend and backend.
  • Checkout to a different feature branch in git and start with the coding part.
  • Make sure to commit your work daily and create a single PR for all your commits, per feature.

Acceptance Criteria

  • Code is short, clean and properly indented.
  • Unused code/comments/variables should not be lying in the code unnecessarily exploiting memory.
  • Minimal number of re-iterations in order to improve efficiency and keep the commit history clean.
  • Best practices should be used in case of multiple approaches, mentors are always there to help you for this 👍

Rejection Criteria

  • Not following/Violating Code of Conduct can lead to rejection.
  • Coding etiquettes must be taken care of, for eg, always committing code in a different feature branch, same PR is edited in case of re-iteration of code, etc.

Expected Outcome

An Admin Dashboard tab inside CodeBadge platform which won't be visible to general members/contributors of the community but only to org admin(s), showing various kind of analytics as to how the organization is performing/growing as well as features to create/edit 'CodeBadges'.

How to excel fast in the community?

  • Share the issues you encounter along the way and help others solve theirs.
  • Chime in below in a comment to cooperate with others who are also working on this task.
  • Report back at the above issue once you succeed, to encourage others and share what worked for you!

Resources & References (Where to Start)

You'll need to go through the docs of Markdown CheatSheet and push your code to this repository to be able to see it at Codeuino Docs.

Extras

Just follow the readme whenever you are stuck . Visit Codeuino's Website in case of any doubts.