Skip to content

Documentation Repository Guildlines

Overview

Welcome hackers! It is awesome to have you here! In this guideline you would learn how to contribute to the below repository:

emmanuelJet/HFA-Doc

Before you start contributing to this project make sure you have read the repository Code Of Conduct, it is really important to make this inclusive and open to everyone, otherwise, it would not be awesome.

This repository contains the files to this documentation and was created to guide attendees of the Hacktoberfest Online Meetup in Ado-Ekiti.

Steps

  1. Fork and Clone the repository
  2. Create a new branch
  3. Add your contribution
  4. Commit and push your fork
  5. Create a pull request
  6. Star the repository

How To Contribute

Fork and Clone the repository

Method 1

To fork and clone the repo easily, execute the below GitHub CLI command: 

  gh repo fork emmanuelJet/HFA-Doc

Method 2

You can also click the Fork button at the right top corner and clone the forked repo using the HTTPS method

Create a new branch

Creating a new branch for your contributions is essential, execute the below Git command to create your branch 

  git checkout -b my-branch-name

NOTE: The best way to replace the my-branch-name key in the above command is your GitHub username. E.g: emmanueljet

Add your contribution

Add your contributions either by fixing bugs, or by adding a new guildline page for repo participating in Hacktoberfest.

Commit and push your fork

After adding your contributions, stage, commit and push your contribution to your forked repo with the below steps:

  1. Staging Changes 
    git add .
  2. Commiting Changes 
    git commit -m '@username: Commit message'
  3. Pushing Changes 
    git push origin my-branch-name

Create a pull request

With the Step 4, your contributions would now be on your forked GitHub Repo. Now you can submit a new pull request from your forked repository to be merged with main repository by clicking the Compare & pull request button on top of your repo. Then click the Create pull request to create a new pull request

Star the repository

It'd be nice to star this Repository while your contribution awaits review from @emmanuelJet

Resources

Conclusion

Pat yourself on the back and wait for your pull request to be reviewed and merged. If merged, check your Hacktoberfest profile because you have earned another contribution.