Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

83 lines (59 loc) · 3.22 KB
Raw

Contributing to GraphJin

GraphJin is a very approchable code-base and a project that is easy for almost anyone with basic GO knowledge to start contributing to. It is also a young project so a lot of high value work is there for the taking.

Even the GraphQL to SQL compiler that is at the heart of GraphJin is essentially a text book compiler with clean and easy to read code. The data structures used by the lexer, parser and sql generator are easy to understand and modify.

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

Setup Development Environment

Prerequisites

  • Install Git (may be already installed on your system, or available through your OS package manager)
  • Install Go 1.13 or above
  • Install Docker

Get source code

The entire build flow uses Makefile there is a whole list of sub-commands you can use to build, test, install, lint, etc.

git clone https://github.com/dosco/graphjin
cd ./graphjin
make help

Start the development envoirnment

Ensure you have a Postgres database running and the config file has the correct connection details to it.

go run main.go db setup
go run main.go serve

Learn how the code works

GraphJin codebase explained

Testing and Linting

make lint
make test

Contributing

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.
  • Simple and minimal approach to features, like Go.
  • Refactoring existing code now for better performance, better readability or better testability wins over adding a new feature.
  • Don't add a function to a module that you don't use right now, or doesn't clearly enable a planned functionality.
  • Don't ship a half done feature, which would require significant alterations to work fully.
  • Avoid Technical debt like cancer.
  • Leave the code cleaner than when you began.

Code style

  • We're following Go Code Review.
  • 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.
  • Avoid unnecessary vertical spaces. Use your judgment or follow the code review comments.
  • Wrap your code and comments to 100 characters, unless doing so makes the code less legible.