If you're not comfortable with the command line, here are tutorials using GUI tools.. If you don't have git on your machine, install it.
1. Fork this repository.
2. Clone your forked copy of the project.
git clone https://github.com/<your_name>/ezmail.git
3. Navigate to the project directory 📁 .
cd ezmail
4. Add a reference(remote) to the original repository.
git remote add upstream https://github.com/IshaanAdarsh/ezmail
5. Check the remotes for this repository.
git remote -v
6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).
git pull upstream master
7. Create a new branch.
git checkout -b <your_branch_name>
8. Perform your desired changes to the code base on that branch.
9. Track your changes ✔️ .
git add .
10. Commit your changes.
git commit -m "Relevant message"
11. Push the committed changes in your feature branch to your remote repo.
git push -u origin <your_branch_name>
12. To create a pull request, click on `compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.
13. Add an appropriate title and description to your pull request explaining your changes and efforts.
14. Click on Create Pull Request.
15 Voila! You have made a PR to Bug Buster's Community Website. Sit back patiently and relax while your PR is reviewed.
After the above setup is done follow these steps to a template
1. Navigate to /src and then to the section you want to contribute to, for example /prof
2. Open the data.js file.
3. You will see a javascript object with the fields slug - the url of the template
title - the subject if the email
subject - a short summary of the main purpose of the email
content - the body of the email
Please note that the
contentfield can only have a string value and strings can not have new lines. Add a\nwherever a new line is to added.
You can also join multiple strings by simply adding a plus sign
"hello"+" world"
4. After doing the necessary formatting. Check the working of the changes made and ensure that everything else is also working fine by running it locally.
5. Create a pull request
Please make sure you have vs code editor installed. If you don't have it, download it.
1. Open VS code and clone the repo .
git clone https://github.com/IshaanAdarsh/ezmail
2. Open all files in vs code.
cd ezmail
3. Install dependencies
npm i
4. Start development server
npm run dev -- --open