Skip to content

Latest commit

 

History

History
391 lines (262 loc) · 15 KB

CONTRIBUTING.md

File metadata and controls

391 lines (262 loc) · 15 KB
Raw

Contributing to Fundamental Library for Angular

We're excited that you're interested in contributing to Fundamental Library for Angular! Your contribution can make this library even better. As a contributor, here are the guidelines we would like you to follow:

Issues and Bugs

If you find a bug or some other issue with any part of the library, please submit an issue. Before doing so, please make sure that:

  • The issue is not a duplicate issue.
  • The issue has not been fixed in a newer release of the library.
  • The issue is reproducible.
  • Your explanation is clear and complete.
  • You provide example code and/or screenshots (recommended).

If you meet the above criteria, you can submit issues with our GitHub issue tracker. Please use labels to categorize your issue.

Feature Requests

You can also use the issue tracker to request a new feature or enhancement. Even if you want to implement the feature yourself, please first submit an issue detailing your proposal so that we may discuss it with you and the community before moving forward. Please use labels when creating feature requests.

Usage of Labels

GitHub offers labels to categorize issues. You can use the following labels:

Labels for issue categories:

  • bug: Issues in the code.
  • documentation: Issues with the documentation.
  • enhancement: Enhancement requests.

Status of open issues:

  • (no label): The default status.
  • unconfirmed: The issue needs to be confirmed as being a bug or future enhancement.
  • approved: The issue is confirmed as being a bug to be fixed or enhancement to be developed.
  • author action: The issue's creator needs to provide additional information.
  • contribution welcome: The fix or enhancement is approved and you are invited to contribute to it.

Status of closed issues:

  • fixed: A fix for the issue was provided.
  • duplicate: The issue is also reported in a different ticket and is being managed there.
  • invalid: The reported issue will not be addressed.
  • works: The issue cannot be reproduced, or the feature is working as expected.
  • wontfix: The issue will not be fixed.

Contribute Code

You are welcome to contribute code to Fundamental Library for Angular in order to fix issues or to add new features.

There are two important things to consider:

  1. You must be aware of the Apache License (which describes contributions) and accept the Developer Certificate of Origin. This is common practice in major Open Source projects. To make this process as simple as possible, we are using CLA assistant for individual contributions. CLA assistant is an open source tool that integrates with GitHub very well and enables a one-click experience for accepting the CLA. For company contributors, special rules apply. See the respective section below for details.
  2. You must follow code style, quality, and product standards requirements. You can find more information HERE.

Local setup

  1. node and yarn is installed as per package.json versions
  2. run yarn to install (npm i without a package.lock probably won't work)
  3. (run yarn prepare)
  4. ckeck if the app works by yarn start

Contributor License Agreement

Developer Certificate of Origin (DCO)

Due to legal reasons, contributors will be asked to accept a DCO before they submit the first pull request to this projects, this happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.

Submission Guidelines

Commit Message Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history.

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer than 100 characters! This ensures that the message is easy to read in GitHub and in other git tools.

The footer should contain a closing reference to an issue if any.

Samples:

docs(core): update changelog to beta.5

fix(platform): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

fix(platform): actionbar as component

Revert

If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
  • 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
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Scope

The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages).

The following is the list of supported scopes:

  • core
  • platform
  • docs
  • e2e
  • cdk
  • cx

There are currently a few exceptions to the "use package name" rule:

  • changelog: used for updating the release notes in CHANGELOG.md
  • docs: used for docs-app (angular.io) related changes within the /aio directory of the repo
  • shared: changes across documentation shared by several modules
  • ci: changes to CI tooling
  • release: release commits (auto-generated)
  • deps: changes to dependencies (auto-generated)
  • deps-dev: changes to dev dependencies (auto-generated)
  • changelog

Multiple scopes

To use multiple scopes need to follow those delimiter options are:

  • "/"
  • "\"
  • ","

Samples:

fix(core,platform): message
fix(core\platform): message
fix(core/platform): message

Subject

The subject contains 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

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and should reference the GitHub issues that this commit Closes.

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.

A detailed explanation can be found in this document.

Create PR Guidelines

If you look at the format of our npm packages you will see:

0.11.0-rc.10 which should be read as MAJOR . MINOR . PATCH PR-BUILD.

The number of the PR Title (not commit message) will be chosen automatically as part of the CI process.

PR Title Format

The PR title must follow this format:

<type>(<scope>): <subject>

Samples:

feat: my adding new binding to button component

chore: updated package.json
Type

Type can have following values: WIP|feat|chore|test|docs|fix.

The WIP represent work in progress and it will not be merged, so please make sure to use one of the specific format such as feat|chore|test|doc|fix if your PR needs to be merged with main

Scope

The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages). Capitalize the first letter.

The following is the list of supported scopes:

  • core
  • platform
  • docs
  • e2e

Here are following rules behind the PR title message:

  • Bump up PATCH version - fix: or feat:
    • Here goes all the features and fixes commits
  • To bump up the MINOR version (the feature):
    • We run script to change the middle number.
  • To bump the MAJOR
    • Run script as well. The process was adjusted to work only with Patch and Minor versions at the moment

Submitting an Issue

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

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 will be insisting on a minimal reproduction scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger code-base but we really need to isolate the problem before we can fix it.

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.

Submitting a Pull Request (PR)

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

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

  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 up front helps to ensure that we're ready to accept your work.

  3. Fork the fundamental-ngx repo.

  4. Make your changes in a new git branch:

    git checkout -b my-fix-branch main

  5. Create your patch, including appropriate test cases.

  6. Follow our Coding Rules. // Todo: Link to other document guidelines

  7. Run the full test suite and ensure that all tests pass.

  8. Run the full lint suite and ensure that all checks 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 -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  10. Push your branch to GitHub:

    git push origin my-fix-branch

Make sure you rebase before you push - to guarantee your branch is not outdated!

There should not be any Merge commits. When they are you haven't properly rebased!

  1. In GitHub, Create Pull Request.

  • If we suggest changes then:

    • Make the required updates.

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

    • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

      git rebase main -i
git push -f

That's it! Thank you for your contribution!

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 (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 main with the latest upstream version:

    git pull --ff upstream main

CI PipeLine

Full description of current CI PipeLine can be found here.

Coding Rules

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

Signing the CLA

Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code changes to be accepted, the CLA must be signed. It's a quick process, we promise!

  • For individuals we have a [simple click-through form][individual-cla].
  • For corporations we'll need you to [print, sign and one of scan+email, fax or mail the form][corporate-cla].

If you have more than one Git identity, you must make sure that you sign the CLA using the primary email address associated with the ID that has been granted access to the Angular repository. Git identities can be associated with more than one email address, and only one is primary. Here are some links to help you sort out multiple Git identities and email addresses:

Note that if you have more than one Git identity, it is important to verify that you are logged in with the same ID with which you signed the CLA, before you commit changes. If not, your PR will fail the CLA check.