Skip to content

Latest commit

 

History

History
64 lines (37 loc) · 1.94 KB

README.md

File metadata and controls

64 lines (37 loc) · 1.94 KB

DocBook

Documentations of Html to every open source technologies. It's a low-code repository This respository is specially for newcomers who wants to enhance their documentation skills by making small/large projects.

How to Start?

If you have a idea of any web projects you want to build just open an appropriate issue regarding this, we will discuss and assign you that issue. In case you are confused and have queries, just ping me, will help you get along and build!

Submit a Pull Request :

Branch naming convention is as following

TYPE-ISSUE_ID-DESCRIPTION

When TYPE can be:

  • feat - is a new project
  • doc - documentation only changes
  • fix - a bug fix/improving of any project

All PRs must include a commit message with the changes description!

For the initial start, fork the project and use git clone command to download the repository to your computer

. A standard procedure for working on an issue would be to:

  1. git pull, before creating a new branch, pull the changes from upstream. Your master needs to be up to date.
$ git pull
  1. Create new branch from master
$ git checkout -b [name_of_your_new_branch]
  1. Work - commit - repeat ( be sure to be in your branch )

  2. Push changes to GitHub

$ git push origin [name_of_your_new_branch]
  1. Submit your changes for review If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.

  2. Start a Pull Request Now submit the pull request and click on Create pull request.

  3. Get a code review approval/reject

  4. After approval, merge your PR

  5. GitHub will automatically delete the branch after the merge is done. (they can still be restored).

  6. You made it! 🎊

Thanks to all the people who have contributed:

Contributors