Skip to content
This repository has been archived by the owner on Mar 19, 2023. It is now read-only.

Latest commit

 

History

History
118 lines (93 loc) · 3.89 KB

contributing.md

File metadata and controls

118 lines (93 loc) · 3.89 KB
Raw

Contributing to GFX Encyclopedia

Hello and thanks for taking your time to contribute!

The following is a set of guidelines for contributing to GFX Encyclopedia. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of conduct

This project and everyone participating in it is governed by the Contributor Covenant Code of Conduct version 2.0. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Commit and pull request

Forking repository

Forking a repository is a simple two-step process. Please follow this instruction below.

  1. Navigate back to the repository root (theNewbieClub-MAL/gfxEncyclopedia). You can pass this step if on Desktop.
  2. In the top-right corner of the page, click Fork.
    Sample

Cloning repository

To clone this repository you need Git installed on your end and the repository need to be forked (see: Forking repository) to your GitHub account. From your command line:

git clone https://github.com/<YOUR USERNAME>/gfxEncyclopedia

Note
Remember to change <YOUR USERNAME> into your GitHub username.

Commit changes

There is no strict guidelines for adding commit message. However, the best one is make it "uniform."

We commonly use those for prefix:

  • Add
    when file is untracked by git.
  • Modify or Fix
    when there some lines modified from previous. Use fix if it resolve bug on project.
  • Update
    when some information updated.

Pulling a merge request

  1. Make sure you have required to naming your commit based on Commit changes guideline.
  2. Name your pull request as
    Detail: Comment
    Note:
    Detail
    Defining what the purpose of this pull request.
    Available arguments, at the moment:
    Add, Modify, Fix
  3. On comment section, fill any information that were required.
  4. Click on the green "Send pull request" button to finish creating the pull request.
  5. You should now see an open pull request.

Issuing Suggestion or Problem

Got a great idea or found an issue but can not executing as well, or unfamiliar with Git interface? Now, you can relax more because GitHub has a great feature, called GitHub Issue. It helps users to "interact" developers with 0 knowledge of coding.

You can send us an issue for we can look for it.

Issuing Suggestion

  1. Open theNewbieClub-MAL/gfxEncyclopedia/issues and tap on New Issue button.
  2. In title bar, write: 
    Suggestion: <your comment>
  3. Adding additional comment/information would helps us figuring out what you want to suggest with.
  4. If you finished writing issue, tap Submit new issue.
  5. You should now see an open issue.

Issuing Problem

    theNewbieClub-MAL/gfxEncyclopedia/issues and tap on New Issue button.
  1. In title bar, write: 
    <your comment>
  2. Adding additional comment/information would helps us figuring out what problem(s) is/are occurred.
  3. If you finished writing issue, tap Submit new issue.
  4. You should now see an open issue.