Skip to content

Latest commit

 

History

History
241 lines (161 loc) · 9.87 KB

CONTRIBUTING.md

File metadata and controls

241 lines (161 loc) · 9.87 KB
Raw

Contributing to this Project

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Using the Issue Tracker

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests, but please respect the following restrictions:

  • Please DO NOT use the issue tracker for personal support requests (use Stack Overflow or IRC).

  • Please DO NOT derail or troll issues. Keep the discussion on topic and respect the opinions of others.

Bug Reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce it using the latest master or development branch in the repository.

  3. Isolate the problem — create a reduced test case and a live example.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Example:

The `paper-foo` element causes the page to turn pink when clicked.

## Expected Outcome

The page stays the same color.

## Actual Outcome

The page turns pink.

## Steps to Reproduce

1. Put a `paper-foo` element in the page.
2. Open the page in a web browser.
3. Click the `paper-foo` element.

As much as possible, please provide a reduced test case that demonstrates the problem.

Feature Requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

If you still want to file an issue to request a feature, please provide a clear description of the feature. It can be helpful to describe answers to the following questions:

  1. Who will use the feature? “As someone filling out a form…”
  2. When will they use the feature? “When I enter an invalid value…”
  3. What is the user’s goal? “I want to be visually notified that the value needs to be corrected…”

Pull Requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

When submitting pull requests, please provide:

  1. A reference to the corresponding issue or issues that will be closed by the pull request. Please refer to these issues in the pull request description using the following syntax:

    (For a single issue)
Fixes #20

(For multiple issues)
Fixes #32, fixes #40

  2. A succinct description of the design used to fix any related issues. For example:

    This fixes #20 by removing styles that leaked which would cause the page to turn pink whenever `paper-foo` is clicked.

  3. At least one test for each bug fixed or feature added as part of the pull request. We will still consider approving your pull request but if you can add a test, please add them :)

To contribute your work:

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/<project-name> %>
# Navigate to the newly cloned directory
cd <project-name>
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/<your-username>/<project-name> %>

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout <dev-branch>
git pull upstream <dev-branch>

  3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

  5. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream <dev-branch>

  6. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  7. Open a Pull Request with a clear title and description.

Contributing Rules (Frontend)

Adding an additional npm package without a clear detail on why it should be added and the byte impact it would add will be disapproved immediately.

I know this is not inherent in the docs (and I think I now have to add that) but I am focusing on making this a performant module. Adding packages at whim is an anti-pattern and I discourage the use of extra libraries without a clear reason WHY it should be part of this module.

Conventional Commit Messages

Contributors MUST follow the git commit conventions proposed by the Angular team when writing commits.

Here is an example of the release type that will be done based on commit messages (from semantic-release):

Commit Message Release Type
fix(pencil): stop graphite breaking when too much pressure applied Patch Release
feat(pencil): add 'graphiteWidth' option MINOR Feature Release
perf(pencil): remove graphiteWidth option

BREAKING CHANGE: The graphiteWidth option has been removed.
The default graphite width of 10mm is always used for performance reasons.		 MAJOR Breaking Release

To assist contributors, Commitizen will be used. This is done by following these steps:

Stage

Pick files to be staged using the side bar Source Control view

Commit

Commit either using the Commitizen Control Panel via the Command Pallete (shift + command + P) and then answer the following information. Or run npm run commit on your Vagrant machine.

The following rules will guide contributors to answer the questions:

Type

MUST be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing or correcting existing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Scope (Optional)

The scope could be anything specifying place of the commit change. For example a filename, or component name, or page name, etc...

You can use an asterisk (*) when the change affects more than a single scope.

Body

The body of commit has two parts: the action, and the description. It should be in the imperative tense.

Action
  • use the imperative, present tense: "change", not "changed" nor "changes"
  • do not capitalize first letter
Description
  • should complete the sentence started by the action
  • no dot (.) at the end

Longer Description (Footer - Optional)

This is where you should add more information. This should include more information on the motivation of the change stated in the Body. Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

Commitizen will help in adding Breaking Changes or if it is connected to an issue number.

Push

Commits will be merged and pushed to the default release or base branch (often master) after review once any CI checks and workflows have passed and a stable build is ensured. Releases and version tags will be made as necessary.