Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (36 loc) · 3.61 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 3.61 KB

Welcome to JUI contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be greatly appreciated ✨.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing and merging the PR. Use the table of content on the top left corner of this document to get to a specific section of this quide quickly.

Guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

Steps

There are a few things you'll need in order to properly start hacking on it.

  1. Fork it
  2. Install dependencies and initialize environment
  3. Hack, in no particular order:
    • Write enough code
    • Write tests for that code
    • Check that other tests pass
    • Repeat until you're satisfied
  4. Submit a pull request

Issues

Create a new issue

If you spot a problem with the docs, search if an issue already exists. (how to). If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The JUI team thanks you ✨.

Now that you are part of the JUI community, see how else you can contribute to JUI