Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

58 lines (37 loc) · 2.97 KB
Raw

Contributing

Hi there! We are small team thrilled that you'd like to contribute to our projects under Hacktoberfest.

Contributions to this project are released to the public under the project's open source license.

Opening an issue

Thank you for taking the time to open an issue, your feedback helps make Hacktoberfest better. Before opening an issue, please be sure that your issue hasn't already been asked by using GitHub search

Here are a few things that will help us help resolve your issues:

  • A descriptive title that gives an idea of what your issue refers to
  • A thorough description of the issue, (one word descriptions are very hard to understand)
  • Screenshots (if appropriate)
  • Links (if appropriate)

Submitting a pull request

  1. Clone the repository
  2. Configure and install the dependencies: (See the README for more details)
  3. Create a new branch: git checkout -b my-branch-name
  4. Make your changes, push to your branch and submit a pull request.
  5. Wait for your pull request to be reviewed and merged!

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Formatting and styling

This repository follows formatting and styling rules defined in .eslintrc and .prettierrc files and are applied via the Prettier and ESLint packages. Please make sure that your changes are linted before opening pull requests to this repository.

Linting setup

  1. Make sure Node.js is installed on your machine.
  2. In the root directory run npm install to install all dependencies.

VSCode

If you are using VSCode, the official Prettier and ESLint extensions allow for automatic linting and formatting in the editor.

CLI commands

  1. Run ./node_modules/.bin/eslint . to check for linting errors.
  2. Run ./node_modules/.bin/eslint --fix . to attempt fixing issues automatically.
  3. Run npx prettier --check . to check for formatting errors.
  4. Run npx prettier --write . to automatically format all files in the directory.

Resources