Skip to content

Latest commit

 

History

History
123 lines (79 loc) · 5.17 KB

CONTRIBUTING.md

File metadata and controls

123 lines (79 loc) · 5.17 KB
Raw

Contribution Guide

If you have any comment or advice, please report your issue, or make any change as you wish and submit a PR.

Reporting New Issues

  • Please specify what kind of issue it is.
  • Before you report an issue, please search for related issues. Make sure you are not going to open a duplicate issue.
  • Explain your purpose clearly in labels, title, or content.

We will confirm the purpose of the issue, replace more accurate labels for it, identify related milestone, and assign developers working on it.

Submitting Code

Pull Request Guide

  1. [Fork][fork] and clone the repository
  2. Configure and install the dependencies pnpm
  3. Make sure the tests pass on your machine pnpm test, note: these tests also run the TypeScript compiler (tsc) to check for type errors, so there's no need to run these commands separately.
  4. Create a new branch git checkout -b my-branch-name for development. The name of branch should be semantic, avoiding words like 'update' or 'tmp'. We suggest to use 'feature/xxx', if the modification is about to implement a new feature.
  5. Run the test pnpm test after you finish your modification. Add new test cases or change old ones if you feel necessary.
  6. Push to your fork and [submit a pull request][pr]
  7. Pat your self on the back and wait for your pull request to be reviewed and merged.

No one can guarantee how much will be remembered about certain PR after some time. To make sure we can easily recap what happened previously, please provide the following information in your PR.

  1. Need: What function you want to achieve (Generally, please point out which issue is related).
  2. Updating Reason: Different with issue. Briefly describe your reason and logic about why you need to make such modification.
  3. Related Testing: Briefly describe what part of testing is relevant to your modification.
  4. User Tips: Notice for html-to-image users. You can skip this part, if the PR is not about update in API or potential compatibility problem.

Style Guide

tslint can help to identify styling issues that may exist in your code. Your code is required to pass the test from tslint. Run the test locally by $ pnpm lint.

Commit Message Format

You are encouraged to use angular commit-message-format to write commit message. In this way, we could have a more trackable history and an automatically generated changelog.

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

（1）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
  • deps: Updates about dependencies

（2）scope

The scope could be anything specifying place of the commit change.

（3）subject

Use succinct words to describe what did you do in the commit change.

（4）body

Feel free to add more content in the body, if you think subject is not self-explanatory enough, such as what it is the purpose or reasons of you commit.

（5）footer

  • If the commit is a Breaking Change, please note it clearly in this part.
  • related issues, like Closes #1, Closes #2, #3

e.g.

fix($compile): [BREAKING_CHANGE] couple of unit tests for IE9

Older IEs serialize html uppercased, but IE9 does not...
Would be better to expect case insensitive, unfortunately jasmine does
not allow to user regexps for throw expectations.

Document change on bubkoo/html-to-image#123

Closes #392

BREAKING CHANGE:

  Breaks foo.bar api, foo.baz should be used instead

Look at these files for more details.

Release

We use semantic versioning in release process based on semver.

Branch Strategy

master branch is the latest stable version.

  • Just checkout develop branch from master
  • All new features will be added into master or next branch as well as all bug-fix except security issues. In such way, we can motivate developers to update to the latest stable version.

Release Strategy

In the release of every stable version, there will be a PM who has the following responsibilities in different stages of the release.

Preparation

  • Set up milestone. Confirm that request is related to milestone.

Before Release

  • Confirm that performance test is passed and all issues in current Milestone are either closed or can be delayed to later versions.
  • Open a new Release Proposal MR, and write History as node CHANGELOG. Don't forget to correct content in documentation which is related to the releasing version.
  • Nominate PM for next stable version.