Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

83 lines (52 loc) · 2.92 KB

Contributing Guidelines

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

When contributing to devtoolbox, wheter 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 change you want to make, and open a pull request only when your suggestions get apporved by maintainers.

Table Of Contents

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 enviroment

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.

In order to contribute to this project, you will need to fork the repository:

gh repo fork jcanotorr06/devtoolbox

then, clone it to your local machine:

gh repo clone <your-github-name>/devtoolbox

This project uses yarn as its package manager. Install it if you haven't already:

npm install -g yarn

Then, install the project's dependencies:

yarn install

Implement your changes

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
  • Please also make a manual, functional test of your changes.

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

NOTE: All pull requests should target the next branch.

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.