Skip to content

Contribution Guidelines

Jump to bottom
sbibow edited this page Dec 16, 2018 · 6 revisions

Contribution Guidelines

This is a guide on how to contribute to the Coding Garden Commuity App. In here, you will find all the information about opening issues, pull requests, and getting involved. This is a beginner friendly project and all are welcome to help! We are happy to take on any and all skills you may bring to the garden! Please take a look below at our cultivated resources and see where to start. Have fun and happy coding!

Table of Contents

Opening Issues

All bug reports or feature requests are managed with GitHub Issues. If you want to submit an issue just go to https://github.com/CodingGardenCommunity/app-wiki/issues/new and fill out the template.

or:

Trello

Documentation

If you are a developer and want to check out the documentation you can check it out at ????.

Submitting Features

This next section will outline the steps you need to take to improve the app.

Forking the repository

If you want to make an edit you first need to fork the corresponding repository. This will create your own copy of the repo at your Github namespace. Now you can clone or directly download it your machine.

After clone your repositry to your local machine you want to create a new branch to work on. You can create a new branch with the command git checkout -b branch-name. Now you can start setting up your local environment to start coding 🎉

Setting up the Local Environment

Check out the README.md of the project to see how the project can be built locally.

or:

All projects are built on NodeJS. If you haven't installed NodeJS you can do so on the official website. After this just enter the directory of the repository with your favourite shell and type npm install (or yarn install).

Here comes project specific description:

  • Database
    • Mocking
    • Setting up local db
  • Envrionment variables
    • Copying .env-sample and setting values
  • Other prerequisites

After those steps you can start the applications with npm run start / yarn dev / whatever.

Creating a Pull Request

Before creating the pull request please make sure, that all tests pass. To run the complete test suite run npm run test / yarn test.

The tests consist of linting, unit and end2end-Tests.

The first checks if the code style is according to the code style guidelines. The other tests are there to check if the app behaves as expected. If the tests are failing and you don't know why, feel free to contact a project owner.

Code of Conduct

Please refer to the full Coding Garden Code of Conduct for community guideline and rules. Basically, dont be a dick. ✨

Where to get help

Call the president of the US of A. They will provide help.

Thank you to everyone involved!

Clone this wiki locally