Skip to content

Latest commit

 

History

History
88 lines (60 loc) · 3.55 KB

CONTRIBUTING.md

File metadata and controls

88 lines (60 loc) · 3.55 KB
Raw

Contributing Guide

If you feel insecure about how to start contributing, feel free to ask us on our Discord channel, in the #contrib channel. You can also just go ahead with your contribution and we'll give you feedback. Don't worry! - the worst that could happen is, you'll be politely asked to change something. We appreciate any contributions, and we don't want a wall of rules to stand in the way of that.

However, for those individuals who want a bit more guidance on the best way to contribute to the project, read on. This document covers what we're looking for. By addressing the points below, the chances that we can quickly merge or address your contributions will increase.

Overview

hasura/learn-graphql repo consists of tutorials for frontend, mobile and backend.

Tutorials

Our goal is to keep our tutorial content and the apps associated with it comprehensive and updated. If you would like to help us in doing so, we are grateful for any kind of contribution:

  • Add new tutorials (please reach out to us if you have ideas to avoid duplicate work).

  • Report missing content.

  • Fix errors in existing tutorials.

  • Help us in updating the app's versions.

Ways of contributing

Reporting an Issue

  • Provide steps to reproduce an issue, including the tutorial that you are trying out.

  • Please include logs, if relevant.

Working on an issue

  • Please make sure there is an issue associated with the work that you're doing.

  • If you're working on an issue, please mention that you are doing so to prevent duplicate work by others and also it prevents any conflicts in the pull request.

  • Squash your commits and refer to the issue using fix #<issue-no> or close #<issue-no> in the commit message, at the end. For example: resolve answers to everything (fix #42) or resolve answers to everything, fix #42

  • Rebase master with your branch before submitting a pull request.

Steps for contributing

We use the fork-and-branch git workflow.

  • Fork the repo and clone it: 
    git clone https://github.com/<your-username>/learn-graphql
  • Navigate to the learn-graphql folder via the command line: 
    cd learn-graphql
  • Checkout a new branch: 
    git checkout -b <new-branch-name>
  • Make the required code changes.
  • Track your changes: 
    git add .
  • Commit your changes. Follow the guidelines for commit messages. 
    git commit -m "Relevant message"
  • Push the committed changes in your feature branch to your remote repo: 
    git push -u origin <your_branch_name>
  • Create a new Pull Request in this repository.

Commit messages

  • The first line should be a summary of the changes, not exceeding 50 characters, followed by an optional body which has more details about the changes. Refer to this link for more information on writing good commit messages.

  • Use the imperative present tense: "add/fix/change", not "added/fixed/changed" nor "adds/fixes/changes".

  • Don't capitalize the first letter of the summary line.

  • Don't add a period/dot (.) at the end of the summary line.

(Credits: Some sections are adapted from https://github.com/smaranjitghose/awesome-portfolio-websites/blob/master/CONTRIBUTING.md)