Skip to content

Latest commit

 

History

History
100 lines (70 loc) · 6.59 KB

CONTRIBUTING.md

File metadata and controls

100 lines (70 loc) · 6.59 KB
Raw

Contributing

This is a general contribution guide for all of the Poppinss repos. Please read this guide thoroughly before contributing to any of the repos 🙏

Reporting bugs

Many issues reported on open-source projects are usually questions or misconfiguration at the reporter's end. Therefore, we highly recommend you properly troubleshoot your issues before reporting them.

If you're reporting a bug, include as much information as possible with your written code samples. The scale of good to bad issues looks as follows.

  • PERFECT ISSUE: You isolate the underlying bug. Create a failing test in the repo and open a Github issue around it.

  • GOOD ISSUE: You isolate the underlying bug and provide a minimal reproduction of it as a Github repo. Antfu has written a great article on Why Reproductions are Required.

  • DECENT ISSUE: You correctly state your issue. Share the code that produces the issue in the first place. Also, include the related configuration files and the package version you use.

    Last but not least is to format every code block properly by following the Github markdown syntax guide.

  • POOR ISSUE: You dump your question, hoping the other person will ask the relevant questions and help you. These kinds of issues are closed automatically without any explanation.

Creating pull requests

Personal note: I am usually less eager to accept new features as pull requests. In the long run, I have to do all the maintenance work and port these features during re-writes.

Therefore, do not take it personally if I decline your PR. I am not ready to take on more work at this time.

It is never a good experience to have your pull request declined after investing a lot of time and effort in writing the code. Therefore, we recommend you open an issue explaining the proposed changes before starting any new work on your side.

Create an issue to explain how you are planning to contribute.

  • Are you trying to create a PR to fix a bug: PRs for bugs are mostly accepted once the bug has been confirmed.
  • Are you planning to add a new feature: Please thoroughly explain why this feature is required and share links to the learning material we can read to educate ourselves.

Note: You should also be available to open additional PRs for documenting the contributed feature or improvement.

Repository setup

  1. Start by cloning the repo on your local machine.

    git clone <REPO_URL>

  2. Install dependencies on your local. Please do not update any dependencies along with a feature request. If you find stale dependencies, create a separate PR to update them.

    We use npm for managing dependencies; therefore, do not use yarn or any other tool.

    npm install

  3. Run tests by executing the following command.

    npm test

Tools in use

Following is the list of tools in use.

Tool Usage
TypeScript All of the repos are authored in TypeScript. The compiled JavaScript and type definitions are published on npm.
TS Node We use ts-node to run tests or scripts without compiling TypeScript. The main goal of ts-node is to have a faster feedback loop during development
SWC SWC is a Rust based TypeScript compiler. TS Node ships with first-class support for using SWC over the TypeScript official compiler. The main reason for using SWC is the speed gain.
NP We use np to publish our packages on npm. Np does all the heavy lifting of creating a release and publishes it on npm and Github. The np config is defined within the package.json file.
ESLint ESLint helps us enforce a consistent coding style across all the repos with multiple contributors. All our ESLint rules are published under the eslint-plugin-adonis package.
Prettier We use prettier to format the codebase for consistent visual output. If you need clarification about why we are using ESLint and Prettier, please read the Prettier vs. Linters doc on the Prettier website.
EditorConfig The .editorconfig file in the root of every project configures your Code editor to use a set of rules for indentation and whitespace management. Again, Prettier is used for post-formatting your code, and Editorconfig is used to configure the editor in advance.
Conventional Changelog All of the commits across all the repos uses commitlint to enforce consistent commit messages.
Husky We use husky to enforce commit conventions when committing the code. Husky is a git hooks system written in Node

Commands

Command Description
npm run test Run project tests using ts-node
npm run compile Compile the TypeScript project to JavaScript. The compiled output is written inside the build directory
npm run typecheck Perform type checking without creating the JavaScript output build.
npm run release Start the release process using np
npm run lint Lint the codebase using ESlint
npm run format Format the codebase using Prettier
npm run sync-labels Sync the labels defined inside the .github/labels.json file with Github. This command is for the project admin only.

Coding style

All of my (Harminder Virk) projects are written in TypeScript. But, slowly, I am also moving everything to pure ESM.

Also, make sure to run the following commands before pushing the code.

# Formats using prettier
npm run format

# Lints using Eslint
npm run lint

Getting recognized as a contributor

We rely on Github to list all the repo contributors in the right-side panel of the repo. Following is an example of the same.

Also, we use the auto generate release notes feature of Github, which adds a reference to the contributor profile within the release notes.