Skip to content

Latest commit

 

History

History
221 lines (143 loc) · 10.4 KB

CONTRIBUTING.md

File metadata and controls

221 lines (143 loc) · 10.4 KB
Raw

Contributing to fork-ts-checker-webpack-plugin

✨ Thanks for contributing to fork-ts-checker-webpack-plugin! ✨

As a contributor, here are the guidelines we would like you to follow:

We also recommend that you read How to Contribute to Open Source.

Code of conduct

Help us keep fork-ts-checker-webpack-plugin open and inclusive. Please read and follow our Code of conduct.

How can I contribute?

Improve documentation

As a fork-ts-checker-webpack-plugin user, you are the perfect candidate to help us improve our documentation: typo corrections, clarifications, more examples, etc. Take a look at the documentation issues that need help.

Please follow the Documentation guidelines.

Give feedback on issues

Some issues are created without information requested in the Bug report guideline. Help make them easier to resolve by adding any relevant information.

Issues with the design label are meant to discuss the implementation of new features. Participating in the discussion is a good opportunity to get involved and influence the future direction of fork-ts-checker-webpack-plugin.

Fix bugs and implement features

Confirmed bugs and ready-to-implement features are marked with the help wanted label. Post a comment on an issue to indicate you would like to work on it and to request help from the contributors and the community.

Bug report

A good bug report shouldn't leave others needing to chase you for more information. Please try to be as detailed as possible in your report and fill the information requested in the bug report template.

Feature request

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 and fill the information requested in the feature request template

Submitting a Pull Request

Good pull requests, whether patches, improvements, or 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 requests (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

If you have never created a pull request before, welcome 🎉 😄. Here is a great tutorial on how to send one :)

Here is a summary of the steps to follow:

  1. Set up the workspace
  2. If you cloned a while ago, get the latest changes from upstream and update dependencies:
$ git checkout main
$ git pull upstream main
$ yarn install
  1. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:
$ git checkout -b <topic-branch-name>
  1. Make your code changes, following the Coding rules
  2. Push your topic branch up to your fork:
$ git push origin <topic-branch-name>
  1. Open a Pull Request to the main branch with a clear title and description.

Tips:

  • For ambitious tasks, open a Pull Request as soon as possible with the [WIP] prefix in the title, in order to get feedback and help from the community.
  • Allow maintainers to make changes to your Pull Request branch. This way, we can rebase it and make some minor changes if necessary. All changes we make will be done in new commit and we'll ask for your approval before merging them.

Coding rules

Source code

To ensure consistency and quality throughout the source code, all code modifications must have:

  • No linting errors
  • A test for every possible case introduced by your code change
  • Valid commit message(s)
  • Documentation for new features
  • Updated documentation for modified features

Documentation

To ensure consistency and quality, all documentation modifications must:

  • Refer to brand in bold with proper capitalization, i.e. GitHub, fork-ts-checker-webpack-plugin, npm
  • Prefer tables over lists when listing key values, i.e. List of options with their description
  • Use links when you are referring to:
    • a fork-ts-checker-webpack-plugin concept described somewhere else in the documentation, i.e. How to contribute
    • a third-party product/brand/service, i.e. Integrate with GitHub
    • an external concept or feature, i.e. Create a GitHub release
    • a package or module, i.e. The typescript module
  • Use the the single backtick code quoting for:
    • commands inside sentences, i.e. the tsc command
    • programming language keywords, i.e. function, async, String
    • packages or modules, i.e. The typescript module
  • Use the the triple backtick code formatting for:
    • code examples
    • configuration examples
    • sequence of command lines

Commit message guidelines

Atomic commits

If possible, make atomic commits, which means:

  • a commit should contain exactly one self-contained functional change
  • a functional change should be contained in exactly one commit
  • a commit should not create an inconsistent state (such as test errors, linting errors, partial fix, feature with documentation etc...)

A complex feature can be broken down into multiple commits as long as each one maintains a consistent state and consists of a self-contained change.

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.

The footer can contain a closing reference to an issue.

Type

The type is forced by the commitlint package. To see available types, run yarn commit or check changelog.config.js file

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.

Examples

fix(pencil): stop graphite breaking when too much pressure applied

perf(pencil): remove graphiteWidth option`

The default graphite width of 10mm is always used for performance reasons.

BREAKING CHANGE: The graphiteWidth option has been removed.

Working with the code

Set up the workspace

Fork the project, clone your fork, configure the remotes and install the dependencies:

# Clone your fork of the repo into the current directory
$ git clone https://github.com/<your-username>/fork-ts-checker-webpack-plugin
# Navigate to the newly cloned directory
$ cd fork-ts-checker-webpack-plugin
# Assign the original repo to a remote called "upstream"
$ git remote add upstream https://github.com/TypeStrong/fork-ts-checker-webpack-plugin
# Install the dependencies
$ yarn install

Commits

Commit message have to follow conventional-commit standard, for example:

This repository use Commitizen to help you create valid commit messages. After staging your changes with git add, run yarn commit to start the interactive commit message CLI.

Releasing a new version

This plugin uses 📦🚀 semantic-release to automatically generate new versions and publish them on the npm and GitHub.

Releasing a beta version

Experimental features and improvements should be merged into the beta branch. If commits are messy, use squash and merge and put a proper commit message, otherwise use rebase and merge.

Releasing a stable version

Fixes and tested features from the beta branch can be merged with the main branch. Please ensure your branch is up to date with the main and then open a Pull Request.