Skip to content

Latest commit

 

History

History
147 lines (101 loc) · 6.88 KB

CONTRIBUTING.md

File metadata and controls

147 lines (101 loc) · 6.88 KB
Raw

Contributing to @ng-idle

This guide will describe how you can contribute to this module.

Getting Help

Questions and comments for Angular should be directed here.

I ask that you do not use GitHub Issues to ask questions. Instead, please use Gitter or StackOverflow for help.

Reporting Issues

If you find a bug in the source code, an issue with an implementation, or a mistake in the documentation, you can help by submitting an issue in GitHub Issues for this repository.

Submitting an Issue

Please search through existing issues and the archive first to see if your question was already answered or if the issue you are experiencing has already been reported.

Once you have determined that you have an unreported problem, please use the following guidelines when opening an issue.

  • Overview of the Issue - Include any non-minified stack trace and other runtime errors that are available and relevant to the issue.
  • Use Case - Explain why this is a bug for you
  • Angular and @ng-idle version(s) - Is this an issue with Angular, or a regression bug in this module?
  • Reproduce the Error - Please, please, please provide a working example either by including a Plunker or JSFiddle, or an unambiguous set of steps! Doing the footwork up front will allow us to replicate and fix the problem faster.
  • Related Issues - Please note any related issues, if any.
  • Suggest a Fix - If you have an idea of what's causing the problem (line of code or a commit), please point it out.

Git Commit Guidelines

We follow the conventional-changelog format used by the Angular team. You can follow the format manually, but we highly recommend you use a CLI wizard such as Commitizen.

In fact, We have configured this repository to work with Commitizen. First, ensure Commitizen CLI is installed via npm install -g commitizen. Next, make sure the clone of this repository is installed via npm install. You're all set! Now, whenever you want to commit, just stage your changes e.g. git add . and commit using git cz. Follow the prompts and you're done.

Commit Message Format

Each commit message should consist of up to three lines: header, body, and footer. Additionally, the header should be a special format containing the type, scope, and subject.

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

The header is mandatory, however, the scope of the header is optional.

Every line should be no longer than 100 characters.

Revert

Commits that revert a previous commit should begin with revert: followed by the header of the reverted commit. The body should read This reverts commit <hash>, where hash is the SHA of the commit you are reverting.

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
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Scope

The scope should be the aspect or subfeature being affected, such as a task.

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.

Submitting a Pull Request

Please follow these steps to submit a pull request:

  • Look through existing GitHub pull requests to see if a similar pull request already exists, to avoid duplicating efforts.
  • After cloning the repo, install the dev dependencies using npm install.
  • Check out a work branch for your changes. npm checkout -b my-fix master.
  • Make your changes, including test cases.
  • Run npm test. Ensure all tests pass.
  • Run npm run lint and correct any linting warnings or errors. You can automatically fix most linting errors by running npm run lint:fix and committing the resulting changes.
  • Commit using the Git Commit Guidelines.
  • Submit a pull request to ng2-idle:master.
  • We will review your PR, and may suggest changes. If changes are suggested:
    • Make the requested changes.
    • Rerun the test task and correct any issues.
    • Commit the changes to your branch using the commit guidelines.
    • Push the changes to your fork. This will update the PR automatically.
  • Once your PR has been accepted and merged, you can pull the changes into master on your fork and delete your work branch.

Updating an out of date Pull Request

If your pull request is too out of date (resulting in merge conflicts or your changes drift out of scope), we will ask you to rebase and force push the changes to your work branch to update the pull request.

git fetch upstream
git checkout master
git merge upstream/master
git checkout my-fix
git rebase master -i
git push origin my-fix -f

Releasing

If you meet the following:

  • Are a maintainer
  • Have an NPM account w/ OTP
  • Have been added as a maintainer to core and keepalive (in progress)

Then you can do the following to release a new version

  • git checkout master && git pull to ensure you have the latest changes pulled down
  • Run npm run test and make sure it builds and passes tests successfully
  • Run npm run release. Upon successful releasing, it will ask you for your NPM OTP twice (once to publish core and again to publish keepalive)