Manage slots, check evals, history and events. Your agenda42.fr ✨
The project is built on Next.js 14.0.4 with TypeScript for robust server-side rendering and static site generation, powered by React 18.2.0 for dynamic UI components. It prominently features react-big-calendar for advanced calendar functionality, with state management handled by Redux for efficient, scalable data flow.
Welcome to the project! We're super excited to have you here, and we can't wait to see your amazing contributions. Whether you're fixing a bug 🐛, adding a feature ✨, or improving documentation 📚, this guide will help you every step of the way. Let’s dive in! 🚀
First, let’s create your personal copy of the project:
- Click the Fork button in the top-right corner. This will create a copy of the repository in your own GitHub account.
- 🎉 Now you have your own version of the project to work on!
Let’s get the project onto your computer so you can start contributing:
- Copy the URL of your forked repository (e.g.,
https://github.com/<your-username>/agenda42.git). - Open your terminal and type:
git clone https://github.com/<your-username>/agenda42.git
- Move into the project folder:
cd agenda42 - You’re all set to start working locally! 🎉
It’s best to work in a separate branch to keep your changes organized and isolated.
- Create a new branch with a name that describes your work:
git checkout -b feature/my-awesome-feature
- Double-check that you’re in your new branch:
git branch
- You’re ready to go! 🛠️
Let your creativity shine! 🌟 Make the changes you want—whether it’s fixing a bug, adding functionality, or improving the code.
- Check what files you’ve modified:
git status
- Stage your changes to prepare them for commit:
git add <file-name> # Or add everything: git add .
- Commit your changes with a clear and friendly message:
git commit -m "🌟 Added a cool new feature!"
Let’s send your work to your forked repository on GitHub:
git push origin feature/my-awesome-featureThis is the exciting part—sharing your changes with the team! 🎉
Steps 1 through 5 might be automatic if you run the link from the terminal. 🤖
-
Go to your forked repository on GitHub.
-
Switch to your branch (
feature/my-awesome-feature). -
Click the Compare & pull request button.
-
In the Pull Request form:
- Make sure the Base repository is the original repo (
brgman/agenda42). - Set the Base branch to
master. - Select your Head branch (
feature/my-awesome-feature).
- Make sure the Base repository is the original repo (
-
Add a title and description to explain your changes. Be creative! ✨
-
Click Create pull request, and voilà! Your changes are now up for review. 🎉
Don't panic, the classic red Review required badge — totally normal, your code will be reviewed. 🚀
As the project evolves, it’s important to keep your fork synchronized with the original repository:
- Add the original repository as
upstream:git remote add upstream https://github.com/brgman/agenda42.git
- Fetch updates from the original repository:
git fetch upstream
- Merge the updates into your local
masterbranch:git checkout master git merge upstream/master
- Push the updated
masterto your fork:git push origin master
Your contributions, no matter how big or small, make a huge difference to this project. 💖 Don’t be afraid to ask questions, share ideas, or even experiment. You’re part of something amazing, and we’re thrilled to have you on board. Let’s build something incredible together! 🚀
Happy coding! 💻✨
