Skip to content
This repository has been archived by the owner on Jun 27, 2021. It is now read-only.

Latest commit

聽

History

History
65 lines (47 loc) 路 2.84 KB

CONTRIBUTING.md

File metadata and controls

65 lines (47 loc) 路 2.84 KB
Raw

Contributing

We are happy with your help in making the Nuz project better. Please read the project overview and guidelines for contributing bug reports and new code, or it might be hard for the community to help you with your issue or pull request.

馃搩 Overview

Before we jump into detailed guidelines for opening and triaging issues and submitting pull requests, here is some information about how our project is structured and resources you should refer to as you start contributing.

馃搸 Project roles

Reviewer

If you having submit a pull request, you can assign a reviewer is any members below to review and merge your pull request.

Core Committer

The contributors with commit access and release to Nuz project. If you want to become a core committer please start writing PRs.

馃斀 Submitting pull requests

Once you've come up with a good design, go ahead and submit a pull request (PR). When submitting a PR, please follow these guidelines:

  • Base all your work off of the develop branch. The develop branch is where active development happens. Note: we do not merge pull requests directly into master.
  • Limit yourself to one feature or bug fix per pull request.
  • Should include tests that prove your code works.
  • Follow appropriate style for code contributions and commit messages.
  • Be sure your author field in git is properly filled out with your full name and email address so we can credit you.

If your pull request is working in process or not ready to merge, please add WIP: prefix in pull request name.

馃摑 Commit conventions

Nuz is using conventional commits, you can enter commit with the message:

type(scope): commit message

Example:

$ git commit -m "fix(nuz-cli): not found workspace in config"
Allowed聽type聽values:
  • feat - new feature, not a new feature for build script.
  • fix - bug fix, not a fix to a build script.
  • docs - changes to the documentation.
  • meta - formatting, missing semi colons, etc; no production code change.
  • refactor - refactoring production code, eg. renaming a variable.
  • test - adding missing tests, refactoring tests, no production code change.
  • chore - updating grunt tasks etc, no production code change.
  • ci - ci configure.
  • perf - a code change that improves performance.
Example聽scope聽values:
  • nuz-shared - change in @nuz/shared.
  • nuz-utils - change in @nuz/utils.
  • nuz-core - change in @nuz/core.
  • nuz-cli - change in @nuz/cli.
  • nuz-registry - change in @nuz/registry.
  • empty - not defined or included multiple parties.
  • etc.