About Built With Setup Testing Contributing
This repository holds the website for the Dev Club built using Jekyll. Dev Club is a community of students highly enthusiastic about software development, ethical hacking, web designing and all other aspects of programming. We aim to provide a gateway for the people in our institute to join the coding community.
Quick Links:
| Action | Link |
|---|---|
| See our website | https://devclubtcsc.github.io |
| Join the Discord | https://discord.gg/5eNCzS9 |
| Mail us | devclubtcsc@gmail.com |
The following generator is built using the following software, you'll need them installed in your workspace to run properly.
The generator uses Jekyll as backend framework to generate the website.
-
Setting up workspace
-
Ruby
- Setup Ruby as per your host operating system following the guide from from https://www.ruby-lang.org/en/documentation/installation/
-
Jekyll
- Install Jekyll from https://jekyllrb.com/docs/installation/
-
- Fork the repository
- Clone the repository
git clone forked-repository-link - Navigate inside the repository
cd devclubtcsc.github.io - Install the dependencies
bundler install
🚧 Under Construction 🚧
To add a new feature or fix a bug follow the steps -
- Make sure your local workspace is up-to-date with the main repository.
- Add the original repository as
upstreamin you local git remotegit remote add upstream https://github.com/devclubtcsc/devclubtcsc.github.io - Fetch the latest code
git fetch upstream - Checkout to your local master branch
git checkout master - Merge changes from
upstream/masterto syncgit merge upstream/master
- Add the original repository as
- Create a new branch to work on the new feature or bug via the updated master branch
git checkout -b "branch_name" - Name the branch something
like fixes-xxx-issueoradd-xxx-featurewherexxxis a short description of the changes or feature you are adding. - Work on feature/bug and stage all the files to commit it on that branch
git add .>git commit -m "Commit Message" - Push the branch to your fork
git push -u origin branch_name - Create a pull request.
A list of contributors can be found here.