Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 1.38 KB
Raw

Contributing

Thank you for considering contributing to this project! We welcome all contributions, big or small.

Before you begin

When contributing to this repository, please first discuss the change you wish in an existing issue, or make a new issue using one of the templates. Doing this before you make any code changes can ensure your time is not spent in vain.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Getting Started

To get started, follow these steps:

  1. Fork this repository.
  2. Clone your forked repository to your local machine.
  3. Install the necessary dependencies using NPM (npm install).
  4. Make your changes.
  5. Test your changes using the npm test command.
  6. Commit your changes to your forked repository.
  7. Submit a pull request.

Adding yourself as a contributor to this project

When submitting a pull request, you might also want to add yourself as a contributor on this project. To do that, you can use the all-contributors CLI.

To do that, run the following terminal command while you are working on this project: npx all-contributors add <username> code. Replace <username> with your own GitHub username.

Code of Conduct

This project has a code of conduct. Please read it here.

License

This project is licensed under the LICENSE file.