Skip to content

Kronicle-Debating-Society/Kronicle_Website

Repository files navigation

Kronicle_Website

Welcome to the Kronicle_Website project! We appreciate your interest in contributing. This guide will help you get started with contributing to the project.

Table of Contents

  1. Getting Started
  2. Forking the Repository
  3. Cloning the Repository
  4. Working on the dev Branch
  5. Making Contributions
  6. Pushing Changes
  7. Submitting a Pull Request
  8. Code of Conduct

Getting Started

Before you begin, make sure you have the following tools installed:

  • Git
  • Node.js (if applicable)
  • Any other dependencies specific to the project

Forking the Repository

  1. Go to the Kronicle_Website repository on GitHub.
  2. Click the "Fork" button in the top right to create a copy of the repository under your account.

Cloning the Repository

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

Working on the dev Branch

To keep the main branch stable, all work should be done on the dev branch:

  1. Switch to the dev branch:

    git checkout dev
  2. If the dev branch does not exist, create it:

    git checkout -b dev

Making Contributions

  1. Sync with the latest dev branch: Before making changes, ensure your branch is up-to-date:

    git pull origin dev
  2. Make your changes: Work on your feature or fix in your local dev branch.

  3. Add and commit your changes:

    git add .
    git commit -m "Describe your changes"

Make sure to make a detailed description of your commited changes

Pushing Changes

After committing your changes, push them to your forked repository's dev branch:

git push origin dev

Submitting a Pull Request

Once your changes are pushed to your forked repository:

  1. Go to the original Kronicle_Website repository on GitHub.
  2. Click the "Compare & pull request" button next to your recently pushed branch.
  3. Provide a clear title and description of your changes.
  4. Submit the pull request.

Your pull request will be reviewed, and feedback may be provided before it can be merged.

Code of Conduct

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!

About

No description, website, or topics provided.

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •