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

Contributors Documentation #46

Open
IvanRoblesMX opened this issue Jan 11, 2022 · 0 comments
Open

Contributors Documentation #46

IvanRoblesMX opened this issue Jan 11, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@IvanRoblesMX
Copy link
Collaborator

Narrative

The documentation should be separated for users and contributors.
The user docs in GH-Pages and the contributor docs are in a separate MD file.

Reference:

Screen Shot 2022-01-10 at 21 47 12

Contributors documentation need to have the next points:

  • Stack
  • Local Setup
  • Workflow
  • Conventions
  • Kanban
  • Milestones
  • How to publish

The points above we already have and it shows in the NPM that info shouldn't have to be there.

Screen Shot 2022-01-11 at 9 54 25

Also, that current points need to be updated.

Definition of done

  1. Review
  2. Publish

Acceptance Criteria

A separated MD file with the points described above, the readme.md file should be updated and the current info at npm should be removed and replaced by the info in the readme.md.

@IvanRoblesMX IvanRoblesMX added the enhancement New feature or request label Jan 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant