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

Latest commit

 

History

History
190 lines (144 loc) · 7.24 KB

CONTRIBUTING.md

File metadata and controls

190 lines (144 loc) · 7.24 KB
Raw

Contributing

We appreciate all kinds of contributions. As a contributor, here are the guidelines we would like you to follow:

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our [GitHub Repository][github]. Including an issue reproduction (via StackBlitz, JsBin, Plunkr, etc.) is the absolute best way to help the team quickly diagnose the problem. Screenshots are also helpful.

You can help the team even more and submit a Pull Request with a fix.

Want a Feature?

You can request a new feature by submitting an issue to our [GitHub Repository][github]. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:

  • For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This will also allow 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.
  • Small Features can be crafted and directly submitted as a Pull Request.

Submitting an Issue

If your issue appears to be a bug, and hasn't been reported, open a new issue. Providing the following information will increase the chances of your issue being dealt with quickly:

  • Overview of the Issue - if an error is being thrown a non-minified stack trace helps
  • Angular and @sbb-esta/angular-public Versions - which versions of Angular and @sbb-esta/angular-public are affected
  • Motivation for or Use Case - explain what are you trying to do and why the current behavior is a bug for you
  • Browsers and Operating System - is this a problem with all browsers?
  • Reproduce the Error - provide a live example (using StackBlitz or similar) or a unambiguous set of steps
  • Screenshots - Due to the visual nature of @sbb-esta/angular-public, screenshots can help the team triage issues far more quickly than a text description.
  • Related Issues - has a similar issue been reported before?
  • Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

You can file new issues by providing the above information here.

Submitting a Pull Request (PR)

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

  • Make your changes in a new git branch:

    git checkout -b my-fix-branch master

  • Create your patch, including appropriate test cases.

  • Follow our Coding Rules.

  • Test your changes with our supported browsers and screen readers.

  • Run tests via ng test @sbb-esta/angular-{library and ensure that all tests pass.

  • 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.

  • Push your branch to GitHub:

    git push my-fork my-fix-branch

  • In GitHub, send a pull request to sbb-angular:master. The PR title and message should as well conform to the commit message conventions.

Note: Our builds often run out of memory. To ensure the build can run, set the NODE_OPTIONS environment variable to --max_old_space_size=7168 either locally or globally. (e.g. in PowerShell, the default VS Code terminal: $env:NODE_OPTIONS="--max_old_space_size=7168")

Coding Rules

This project uses prettier and tslint rules to enforce code style. The max line length is 100 characters.

A short introduction to the rules is as follows (Run npm run lint to check validity):

const NUMBER_VALUE = 3;
let stringValue = 'value';
function nameOfTheFunction() { ... }

class SpecialClass {
  somePublicValue = true;
  protected _protectedValue = 'some value';
  private _privateValue = 5;

  aPublicMethod() { ... }
  protected _protectedMethod() { ... }
  private _privateMethod() { ... }
}

Commit Message Guidelines

This project uses Conventional Commits to generate the changelog.

Commit Message Format

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

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

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 tests or correcting existing tests
  • build: Changes that affect the build system, CI configuration or external dependencies (example scopes: gulp, broccoli, npm)
  • chore: Other changes that don't modify src or test files

Scope

The scope could be anything specifying place of the commit change. For example datepicker, dialog, etc.

Subject

The subject contains succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize 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 is also the place to reference 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.

Public/Business Package

This project publishes five packages:

  • @sbb-esta/angular-core
  • @sbb-esta/angular-icons
  • @sbb-esta/angular-keycloak
  • @sbb-esta/angular-public
  • @sbb-esta/angular-business

Styling

This project uses SASS for styling the components.

To differentiate between public and business styles in code that is used in both the mixins publicOnly() and businessOnly() can be used.

padding: 1rem 2rem;

@include publicOnly() {
  margin-bottom: 3rem;
}
@include businessOnly() {
  margin-bottom: 1rem;
}

For business components in projects/sbb-esta/angular-business, it is required to put $sbbBusiness: true; at the top of .scss files.