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.

Sign up for GitHub

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

Jump to bottom

Add basic documentation #6

Closed
5 tasks done
NicolasOmar opened this issue Dec 31, 2022 · 2 comments · Fixed by #7
Closed
5 tasks done

Add basic documentation #6

NicolasOmar opened this issue Dec 31, 2022 · 2 comments · Fixed by #7
Assignees
@NicolasOmar
Labels
documentation Improvements or additions to documentation research Investigation about tech, methodology or other
Milestone
v1.0.0

Comments

@NicolasOmar
Copy link
Owner

NicolasOmar commented Dec 31, 2022 •
edited

Objective

Add the necessary documentation related to the project

Description

The mentioned documentations should cover

  • Issues/stories tags
  • Project description adding column states descriptions
  • Add documentation about selected git branching strategy

Steps

  • Create issue tags related to possible scenarios (like documentation, research, feature, bug, enhancement)
  • Create an issue template for component creation
  • Learn about best practices for ticket workflow
  • Add description related to column status and roadmap main points
  • Learn about possible git branching strategies and document the selected choice

Ticket relationships

Relationship Involved tickets
Is child from none
In parent of none
Is related to #1 - #3
Is blocked by none
It blocks none

Technical notes

none
@NicolasOmar NicolasOmar self-assigned this Dec 31, 2022
@NicolasOmar NicolasOmar added documentation Improvements or additions to documentation research Investigation about tech, methodology or other labels Dec 31, 2022
@NicolasOmar NicolasOmar added this to the v0.0.1 milestone Dec 31, 2022
@NicolasOmar NicolasOmar linked a pull request Dec 31, 2022 that will close this issue
Add issue template for component creation #7
Merged
@NicolasOmar
Copy link
Owner Author

To understand how to integrate my gitflow with semantic-release in a smooth way, I need to get into library documentation before close the ticket

@NicolasOmar
Copy link
Owner Author

NicolasOmar commented Jan 2, 2023 •
edited

The uploaded image is the associated documentation of the first gitflow draft. This poposition will be tested in #3 in order to get the best possible branching strategy which will help an automated way of publish the package in Github and npm with same version number.

Image

@NicolasOmar NicolasOmar mentioned this issue Jan 2, 2023
Closed
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@NicolasOmar NicolasOmar

Labels
documentation Improvements or additions to documentation research Investigation about tech, methodology or other
Projects
Reactive-bulma | Project board
Status: Done
Milestone
v1.0.0
Development

Successfully merging a pull request may close this issue.

Add issue template for component creation NicolasOmar/reactive-bulma
1 participant
@NicolasOmar