First of all, thank you for considering contributing. It helps a lot and helps remove some of the burden from our developer team.
This file will assist you with everything you need to know about setting up a AvBot-Charts development/testing environment, writing code that will be approved, and submitting your code.
In order to work on AvBot-Charts, you need a working development environment.
AvBot-Charts has some prerequisites that need to be met in order to test your new features.
For AvBot-Charts to function, you need to install the Node.js JavaScript Runtime.
Install version 16.5.x.
NPM comes built in with Node.js, so there isn't a need to worry about it.
Now, run the command npm install in your terminal. This will install all of
our dependencies.
Run cp .env.example .env and fill all the variables.
You can use MongoDB Atlas to create a free MongoDB database.
When you write your code, it should be fit enough to be merged.
Your code should be formatted with Prettier after you write it, if you don't then a bot will detect your pull request and do that for you.
Your code should pass all test cases.
Code should be reasonable, and we think you are able to understand what that means.
Ensure you are on your fork before continuing. Create one on GitHub.
Run the following command:
git commit -m "Describe your changes here. Try to use less than 50 characters."
# Or, for an extended description:
git commit -m "Describe your changes here. Try to use less than 50 characters.
Put your extended description here."Push to your fork with this command:
git pushgit push --set-upstream origin mainOn GitHub, select Pull Requests and open a new one.
Fill out our Pull Request template.
Put useful information about the changes there.
Your changes will be reviewed soon. Keep an eye on your pull request!