This is the heart of our club's web presence. Our website acts as a showcase of our activities, projects, and the amazing team behind the scenes. Check it out live: Tarmeez Club Live Website.
To get started with contributing to our repository, you'll need to have a basic understanding of Git and GitHub. Don't worry if you're not a pro, we all started somewhere!
- Git installed on your machine
- GitHub account
First things first, make a clone of the repository:
git clone https://github.com/tarmeezclub/tarmeezclub.github.io.git
cd tarmeezclub.github.io
We use the GitFlow branching strategy. It helps us manage our development process more smoothly and keeps our main branch free of unfinished features.
-
Main Branch: This is our source of truth. All the released features are here. 🎉
-
Develop Branch: This is where we integrate our new features. Think of it as a preparation branch for our next release. 🛠️
-
Feature Branches: Whenever you start working on a new feature, branch off from
develop:git checkout develop git checkout -b feature/<your-feature-name>Code your heart out on your feature! When you're done:
git add . git commit -m "A descriptive message about your feature" git push origin feature/<your-feature-name> -
Pull Requests: When you feel your feature is ready, create a pull request from your feature branch to
develop. The team will review it, and once it's approved, it will be merged. 👍 -
Release Branches: When we decide to make a release, we create a release branch off of
develop. Once it's ready and tested, it's merged intomainand tagged with a version number. 🏷️ -
Hotfix Branches: If we find a bug in
main, we create a hotfix branch. Once fixed, it's merged to bothmainanddevelop. 🚑
-
Creating a new feature branch:
git checkout -b feature/awesome-feature develop -
Finishing a feature:
git checkout develop git merge --no-ff feature/awesome-feature git branch -d feature/awesome-feature git push origin develop -
Starting a release/hotfix:
git checkout -b release/1.2 develop // or git checkout -b hotfix/urgent-fix main
Please read through our CONTRIBUTING.md to understand how you can contribute to this repository. We value your input and are excited to see what you bring to the project!
If you have any questions or run into any issues, don't hesitate to open an issue in the repository. Our maintainers are friendly and more than happy to help you out!
This project is licensed under the MIT License - see the LICENSE.md file for details.
Hat tip to anyone whose code was used, any third-party libraries, and to the wonderful team that keeps the club going!
Remember to adjust the links and file names to match your actual repository structure. The tone is kept light and inviting, with emojis to make it less intimidating for newcomers.