Skip to content

Latest commit

 

History

History
81 lines (52 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

81 lines (52 loc) · 3.09 KB

Contribution Guidelines

When contributing to bskypt, whether on GitHub or in other community spaces:

  • Be respectful, civil, and open-minded.
  • Before opening a new pull request, try searching through the issue tracker for known issues or fixes.
  • If you want to make code changes based on your personal opinion(s), make sure you open an issue first describing the changes you want to make, and open a pull request only when your suggestions get approved by maintainers.

How to Contribute

Prerequisites

In order to not waste your time implementing a change that has already been declined, or is generally not needed, start by opening an issue describing the problem you would like to solve.

Setup your environment locally

Some commands will assume you have the Github CLI installed, if you haven't, consider installing it, but you can always use the Web UI if you prefer that instead.

  1. In order to contribute to this project, you will need to fork the repository:
gh repo fork wriddhi/bskypt
  1. Clone it to your local machine:
gh repo clone <your-github-name>/bskypt
  1. This project uses pnpm as its package manager. Install it if you haven't already:
npm install -g pnpm
  1. Install the project's dependencies:
pnpm install

Implement your changes

This project is a Next.js project. Now you're all setup and can start implementing your changes.

Here are some useful scripts for when you are developing:

Command Description
pnpm dev Starts the development server for the app without https
pnpm dev:https Starts the development server for the app with https
pnpm build Builds the project in production mode
pnpm start Starts the production server for the app without https
pnpm lint Lints the code

When making commits, make sure to follow the conventional commit guidelines, i.e. prepending the message with feat:, fix:, chore:, docs:, etc... You can use git status to double check which files have not yet been staged for commit:

git add <file> && git commit -m "feat/fix/chore/docs: commit message"

When you're done

Check that your code follows the project's style guidelines by running:

pnpm lint

When all that's done, it's time to file a pull request to upstream:

gh pr create --web

and fill out the title and body appropriately. Again, make sure to follow the conventional commit guidelines for your title.

Credits

This documented was inspired by the contributing guidelines for cloudflare/wrangler2.