Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (53 loc) · 4.37 KB

CONTRIBUTING.md

File metadata and controls

98 lines (53 loc) · 4.37 KB

NOTE:

##After you are done contributing and creating a PR, add a comment in the following manner:

@add-contributors please add @<your_username> for <your_contribution_tag>

For a list of all available contribution tags, click here You will be added to contributors list once the PR is merged!

Welcome to zhcet-code-oasis contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on zhcet-code-oasis.github.com ✨.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

Here are some resources to help you get started with open source contributions:

Steps to Submit a PR

  • Fork the repository

    At the top right corner, you will see the term "fork". All you need to do is click it and you will have created a copy of the same project in your account.

    After this operation the URL of the project will change to:

    https://github.com/<YourUserName>/projectname

  • Clone the project into your local machine

    Copy the forked project URL, and proceed to your local machine where you will open git bash, and proceed with the command below:

    git clone https://github.com/<YourUserName>/<projectname>

    This will create a copy of the project on your local machine. Now that you have cloned the repo we will need to do two things:

    First is to make the necessary changes/contribution and commit those changes. After making your changes and adding new files, its time to add those changes into a separate branch before pushing them to remote.

    But, first let's create a branch. In your git bash, change the path to pint to your repository directory. To do that use this command:

    cd project folder name

    Now, to create a branch we will use the command:

    git checkout -b your-new-branch-name

    It's time to add the new changes into the branch we created. In order to see all the changes you made, we will use the git status command:

    git status

    The command will list all the changes you made. To add them we will use git add *, which will add all the files to our branch.

    git add *

    Let's add a commit message, briefly explaining what we added:

    git commit -m "<message here>"

  • Push changes to remote

    Now that everything is set, it's time to let our maintainer know what we have added. That is made possible by pushing the changes with this command:

    git push origin <add-your-branch-name>

    replacing <add-your-branch-name> with the name of the branch you created earlier, in my case it will be git push origin feature/footer.

  • Submit changes

    If you go to your repository on GitHub and refresh the page, you'll see a Compare and pull request button. Click on that button.

Creating an issue from a repository

  1. On your enterprise, navigate to the main page of the repository.

  2. Under your repository name, click Issues.

  3. Click New issue.

  4. If your repository uses issue templates, next to the type of issue you'd like to open, click Get started.

    If the type of issue you'd like to open isn't included in the available options, click Open a blank issue.

  5. Screenshot of the template chooser for an issue. Below the template choices, a link, labeled "Open a blank issue," is outlined in dark orange.

  6. In the "Title" field, type a title for your issue.

  7. In the comment body field, type a description of your issue.

  8. When you're finished, click Submit new issue.