Welcome to the Kronicle_Website project! We appreciate your interest in contributing. This guide will help you get started with contributing to the project.
- Getting Started
- Forking the Repository
- Cloning the Repository
- Working on the
dev
Branch - Making Contributions
- Pushing Changes
- Submitting a Pull Request
- Code of Conduct
Before you begin, make sure you have the following tools installed:
- Go to the Kronicle_Website repository on GitHub.
- Click the "Fork" button in the top right to create a copy of the repository under your account.
Clone the forked repository to your local machine:
git clone https://github.com/your-username/Kronicle_Website.git
Replace your-username
with your GitHub username.
Navigate to the project directory:
cd Kronicle_Website
To keep the main branch stable, all work should be done on the dev
branch:
-
Switch to the
dev
branch:git checkout dev
-
If the
dev
branch does not exist, create it:git checkout -b dev
-
Sync with the latest
dev
branch: Before making changes, ensure your branch is up-to-date:git pull origin dev
-
Make your changes: Work on your feature or fix in your local
dev
branch. -
Add and commit your changes:
git add . git commit -m "Describe your changes"
Make sure to make a detailed description of your commited changes
After committing your changes, push them to your forked repository's dev
branch:
git push origin dev
Once your changes are pushed to your forked repository:
- Go to the original
Kronicle_Website
repository on GitHub. - Click the "Compare & pull request" button next to your recently pushed branch.
- Provide a clear title and description of your changes.
- Submit the pull request.
Your pull request will be reviewed, and feedback may be provided before it can be merged.
Please note that we have a Code of Conduct. By participating in this project, you agree to abide by its terms.
Thank you for contributing to the Kronicle_Website project!
Happy Coding!