Skip to content

Latest commit

 

History

History
32 lines (25 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

32 lines (25 loc) · 1.51 KB

Contributing to Generator-Discord

Thank you for your interest in Generator-Discord! We appreciate your interest in contributing to this project. This document will guide you through the process of making contributions to this open-source project.

How to contribute

You can create an issue or follow the guide below.

1. Fork the repository.

You will need to fork this repository to publish your work to the platform. The fork can then be used to contain your changes and to create a PR.

2. Change whatever you want to change

Now that your fork is ready, you can start improving the project.

Testing the project

Testing your work will always be helpful to check everything works as intended.

1. Add your Discord Bot token to the environment variables

You need to specify a valid Discord-Bot-Token to test the templates.

TOKEN=YOUR_BOT_TOKEN

2. Run the test using

npm run test

You can also use npm link and yo discord to try the generator.

3. Creating the Pull Request

After making all the changes, create a Pull Request selecting your fork to compare to. example

4. Wait for review

A maintainer will now review your code. We will keep you updated.