wpetit
/
super-graph
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update CONTRIBUTING.md

This commit is contained in:
Vikram Rangnekar 2019-12-01 01:17:27 -05:00 committed by GitHub
parent cbfedb6fd2
commit 0f9f8bbf0d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.md
View File

@ -8,21 +8,21 @@ Even the GraphQL to SQL compiler that is at the heart of Super Graph is essentia
Finally we do have a lot of test for critical parts of the codebase which makes it easy for you to modify with confidence. I'm always available for questions or any sort of guidance so feel fee to reach out over twitter or discord. Finally we do have a lot of test for critical parts of the codebase which makes it easy for you to modify with confidence. I'm always available for questions or any sort of guidance so feel fee to reach out over twitter or discord.
* [Getting Started](#get-started) * [Getting Started](#getting-started)
* [Setting Up the Development Environment](#get-setup) * [Setting Up the Development Environment](#setup-development-environment)
* [Prerequisites](#prerequisites) * [Prerequisites](#prerequisites)
* [Get the Super Graph source](#get-source) * [Get the Super Graph source](#get-source-code)
* [Start the development envoirnment ](#start-dev) * [Start the development envoirnment ](#start-the-development-envoirnment)
* [Testing](#testing) * [Testing](#testing-and-linting)
* [Contributing](#contributing) * [Contributing](#contributing)
* [Guidelines](#guidelines) * [Guidelines](#guidelines)
* [Code style](#code-style) * [Code style](#code-style)
## Getting Started {#get-started} ## Getting Started
- Read the [Getting Started Guide](https://supergraph.dev/guide.html#get-started) - Read the [Getting Started Guide](https://supergraph.dev/guide.html#get-started)
## Setting Up the Development Environment {#get-setup} ## Setup Development Environment
### Prerequisites ### Prerequisites
@ -30,7 +30,7 @@ Finally we do have a lot of test for critical parts of the codebase which makes
- Install [Go 1.13 or above](https://golang.org/doc/install) - Install [Go 1.13 or above](https://golang.org/doc/install)
- Install [Docker](https://docs.docker.com/v17.09/engine/installation/) - Install [Docker](https://docs.docker.com/v17.09/engine/installation/)
### Get the Super Graph source {#get-source} ### Get source code
The entire build flow uses `Makefile` there is a whole list of sub-commands you The entire build flow uses `Makefile` there is a whole list of sub-commands you
can use to build, test, install, lint, etc. can use to build, test, install, lint, etc.
@ -41,7 +41,7 @@ cd ./super-graph
make help make help
``` ```
### Start the development envoirnment {#start-dev} ### Start the development envoirnment
The entire development flow is packaged into a `docker-compose` work flow. The below `up` command will launch A Postgres database, a example e-commerce app in Rails and Super Graph in development mode. The `db:seed` Rails task will insert sample data into Postgres. The entire development flow is packaged into a `docker-compose` work flow. The below `up` command will launch A Postgres database, a example e-commerce app in Rails and Super Graph in development mode. The `db:seed` Rails task will insert sample data into Postgres.
@ -54,7 +54,7 @@ docker-compose up
[Super Graph codebase explained](https://supergraph.dev/internals.html) [Super Graph codebase explained](https://supergraph.dev/internals.html)
### Testing and Linting {#testing} ### Testing and Linting
``` ```
make lint test make lint test
@ -62,6 +62,8 @@ make lint test
## Contributing ## Contributing
### Guidelines
- **Pull requests are welcome**, as long as you're willing to put in the effort to meet the guidelines. - **Pull requests are welcome**, as long as you're willing to put in the effort to meet the guidelines.
- Aim for clear, well written, maintainable code. - Aim for clear, well written, maintainable code.
- Simple and minimal approach to features, like Go. - Simple and minimal approach to features, like Go.
@ -72,6 +74,7 @@ make lint test
- Leave the code cleaner than when you began. - Leave the code cleaner than when you began.
### Code style ### Code style
- We're following [Go Code Review](https://github.com/golang/go/wiki/CodeReviewComments). - We're following [Go Code Review](https://github.com/golang/go/wiki/CodeReviewComments).
- Use `go fmt` to format your code before committing. - Use `go fmt` to format your code before committing.
- If you see *any code* which clearly violates the style guide, please fix it and send a pull request. No need to ask for permission. - If you see *any code* which clearly violates the style guide, please fix it and send a pull request. No need to ask for permission.