Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
295 lines (189 loc) · 11.1 KB

CONTRIBUTING.md

File metadata and controls

295 lines (189 loc) · 11.1 KB

Contributing

As a contributor, here are the guidelines we would like you to follow:

Code of Conduct

Help us keep project open and inclusive. Please read and follow our Code of Conduct.

Found a Bug?

If you find a bug in the source code, you can help us by submitting an issue to one of our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Missing a Feature?

You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed:

  • For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. Don't forget to add the "issue: feature-major" label to it.

  • Small Features can be crafted and directly submitted as a Pull Request. Don't forget to add the "pull request: feature-minor" label to it.

  • Documentation changes can be crafted and directly submitted as a Pull Request. Don't forget to add the "pull request: documentation" label to it.

Submission Guidelines

Submitting an Issue

Before you submit an issue, please search the issue tracker. An issue for your problem might already exist and the discussion might inform you of workarounds readily available.

We want to fix all the issues as soon as possible, but before fixing a bug, we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions.

A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.

We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs.

Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced.

You can file new issues by selecting from our new issue templates and filling out the issue template. The main types of issues available are:

  • Bug Report
  • Feature Request
  • Documentation
  • Question
  • Security Report

If you don't find applicable type of issues, you can always create a blank issue. Don't forget to add the "issue: " label to newly created issue. Checkout our label system for it.

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.

  2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work.

  3. Please checkout the Developer Certificate of Origin (DCO) and sign-off all you commits before sending PRs. We cannot accept code without a signed DCO. Make sure you author all contributed Git commits with email address associated with your DCO signature.

  4. Fork the repo.

  5. In your forked repository, make your changes in a new git branch:

     git checkout -b my-fix-branch main

    or

     git checkout -b my-fix-branch develop

    Depends on the base repository branch.

  6. Create your patch, including appropriate test cases.

  7. Follow our Coding Rules.

  8. For the repos containing automated tests, run the full test suite and ensure that all tests pass.

  9. Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.

    git commit --all -s

    Note: the optional commit --all command line option will automatically "add" and "rm" edited files. Don't forget to sign-off your commits according to the Developer Certificate of Origin (DCO). See this guide for how to sign-off correctly.

  10. Push your branch to GitHub:

    git push origin my-fix-branch

  11. In GitHub, send a pull request to main branch of the repository (f.ex repository_name:main or repository_name:develop).

Reviewing a Pull Request

The Print make Lab team reserves the right not to accept pull requests from community members who haven't been good citizens of the community. Such behavior includes not following the Code of conduct .

Addressing review feedback

If we ask for changes via code reviews then:

  1. Make the required updates to the code.

  2. Re-run the test suites to ensure tests are still passing.

  3. Create new commit with a fix and push to your GitHub repository (this will update your Pull Request)

    git commit --all -s HEAD
git push

That's it! Thank you for your contribution!

Updating the commit message

A reviewer might often suggest changes to a commit message (for example, to add more context for a change or adhere to our commit message guidelines). In order to update the commit message of the last commit on your branch:

  1. Check out your branch:
  git checkout my-fix-branch
  1. Amend the last commit and modify the commit message:
  git commit --amend -s
  1. Push to your GitHub repository:
  git push --force-with-lease

NOTE:
If you need to update the commit message of an earlier commit, you can use git rebase in interactive mode. See the git docs for more details.

Don't forget to sign-off your commits according to the Developer Certificate of Origin (DCO). See this guide for how to sign-off correctly.

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main/develop (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

      git push origin --delete my-fix-branch

  • Check out the main branch:

      git checkout main -f

  • Delete the local branch:

      git branch -D my-fix-branch

  • Update your local main or develop (depends on the base repository branch) with the latest upstream version:

      git pull --ff upstream main
      git pull --ff upstream develop

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more specs (unit-tests).
  • All public API methods must be documented.
  • We follow basic style guides for each language, but wrap all code at 100 characters.

Commit Message Format

We are using the Conventional Commits specification as commit message format.

The commit message should be structured as follows:

<type>[optional scope]: <short summary>
  │       │             │
  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope: f.ex. changelog|workflows|common|core|ui|api|dependencies|migrations
  │  
  └─⫸ Commit Type: f.ex.: build|ci|docs|feat|fix|refactor|test|style

[optional body]

[optional footer(s)]

The <type> and <summary> fields are mandatory, the (<scope>) field is optional.

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies
  • ci: Changes to our CI configuration files and scripts
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • refactor: A code change that neither fixes a bug nor adds a feature
  • test: Adding missing tests or correcting existing tests
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • translation: Changes related to support for translation and different languages
Scope

The scope should be the name of the module, npm package, or global part of the project (as perceived by the person reading the changelog generated from commit messages).

  • none/empty string: useful for test and refactor changes that are done across all places and for docs changes that are not related to a specific place (e.g. docs: fix typo in tutorial).
Summary

Use the summary field to provide a succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize the first letter
  • no dot (.) at the end

Commit Message Body (optional)

Just as in the summary, use the imperative, present tense: "fix" not "fixed" nor "fixes".

Explain the motivation for the change in the commit message body. This commit message should explain why you are making the change.

You can include a comparison of the previous behavior with the new behavior in order to illustrate the impact of the change.

Commit Message Footer (optional)

The footer can contain information about breaking changes and deprecations and is also the place to reference GitHub issues, and other PRs that this commit closes or is related to.

Revert commits

If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit.

The content of the commit message body should contain:

  • information about the SHA of the commit being reverted in the following format: This reverts commit <SHA>,
  • a clear description of the reason for reverting the commit message.

Signing the DCO

Please checkout the Developer Certificate of Origin (DCO) and sign-off all you commits before sending pull requests.

For any code changes to be accepted, the DCO must be signed. It's a quick process, we promise!

To sign-off commits see this guide.