Hi there! We're thrilled that you'd like to contribute to Hacktoberfest. Your help is essential for keeping it great.
Thank you for taking the time to open an issue, your feedback helps make Hacktoberfest better. Before opening an issue, please be sure that your issue hasn't already been asked by using GitHub search
Here are a few things that will help us help resolve your issues:
- A descriptive title that gives an idea of what your issue refers to
- A thorough description of the issue, (one word descriptions are very hard to understand)
- Screenshots (if appropriate)
- Links (if appropriate)
-
Clone the repository using :
git clone --recursive [email protected]:atom-robotics-lab/atom-robotics-lab.github.io.git
We need to use the
--recursivetag since it uses submodules for the themes. -
Our website uses an open-source framework called Hugo. Use this link to install and use Hugo
-
Install git-lfs with :
sudo apt-get install git-lfs
-
Refer to the section below if your task requires you to make changes to the theme of the website.
-
Fork the repo and Create a new branch:
git checkout -b my-branch-name
-
Make changes, commit and Push to your branch. Submit a Pull Request
-
Wait for your pull request to be reviewed and merged!
Follow these guidelines if your tasks requires you to make changes to the theme of the website :
- The theme resides in hugo as submodule in the
themesdirectory. If you make changes to the theme and push to this repo they won't be reflected ont the wenbite even though they work locally! Treat the submodule as a separate git repository with a different remote. - After making changes to the theme, you need to push your changes to its remote the same way you would do for any other remote.