Hi! I'm glad to see that you're interested in helping to make Warden better.
Before we proceed, there are a few things to take note of.
It will make the development process a lot simpler and easier to understand.
In order to ensure that Warden runs during development, the prerequisites in README.md must be satisfied first.
I highly recommend using Visual Studio Code if you do not currently use an IDE.
Here are the additional prerequisites for development:
- Git (setup steps here)
- GitHub account
Choose a safe place on your drive.
There's no need to make a folder/directory as it will be generated when you run the commands in the next step.
Run git clone https://github.com/ZPTXDev/Warden.git to clone the repository to the 'Warden' folder/directory.
Then, navigate to the newly created folder/directory through your terminal and run npm ci to install all dependencies.
You may follow this to verify Warden is installed correctly.
This project uses ESLint.
The configuration file is provided at the base of the repository here.
To ensure ESLint is enabled and linting, you must have it installed on your IDE as well.
- From the IDE, open Extensions on the left panel
- Search for ESLint in the Marketplace
- Click Install
- Open Settings / Preferences
- Navigate to the Install tab
- Search for
linter-eslint - Click Install
ESLint is already integrated into your IDE.
I can't guarantee that the steps are the same, but it should be similar.
Try searching for ESLint installation steps on Google for your IDE.
discord.js
This project uses Semantic Commit Messages.
Pull requests are checked for Semantic Commits automatically, meaning checks will fail if you do not adhere to them.
Once you are ready to commit your changes, create a pull request, merging to the next branch.
You may request a review when you are ready. As long as the checks are passing, and there isn't any reason to deny your pull request, it'll be merged.