Thank you for your interest in contributing to this project! Please follow the steps below to set up your development environment and contribute effectively.
Instead of cloning directly, please fork the repository to your own GitHub account:
- Go to the top-right corner of this repo and click Fork
git clone https://github.com/YOUR-USERNAME/REPO-NAME.git
cd REPO-NAME
Always create a separate branch for your changes:
git checkout -b your-feature-branch
This project is powered by Jekyll. Make sure you have the necessary environment set up.
- Ruby (version 2.5.0 or higher recommended)
- Bundler
- Jekyll
If you haven't already, install Jekyll and Bundler:
gem install bundler jekyll
Then install project dependencies:
bundle install
To serve the site locally:
bundle exec jekyll serve
Open http://localhost:4000
in your browser to view the site.
- Make your changes in your branch
- Test your changes locally
- Commit with a clear message:
git add . git commit -m "Add: [Short description of feature or fix]"
- Push to your fork:
git push origin your-feature-branch
- Open a Pull Request to the
main
branch of the mother repo
You should use your repo name as the baseURL in _config.yml - otherwise it will give you deployement errors.
baseurl: "/<repo-name>"
- Follow consistent code style
- Test your changes before submitting
- One feature/fix per pull request
- Reference related issues (if any)
We appreciate your contributions and look forward to collaborating with you!