Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

74 lines (46 loc) · 2.71 KB

Contribution Guidelines

Welcome! We're thrilled that you're interested in contributing to our Jekyll project.

This document outlines the standards and rules of contributing to this project. Please ensure you read and understand these guidelines before submitting any pull request.

Prerequisites

Before you can contribute, you will need:

  • A GitHub account
  • Basic knowledge of Git and Jekyll
  • The project set up on your local machine

Setup and Installation

  1. Fork the repository. Click the Fork button at the top right of this page.

  2. Clone the forked repository to your local machine. Navigate to your GitHub repositories and open the forked repository called <Your-GitHub-Username>/repository-name. Click the "Code" button and copy the HTTPS URL. Then open a terminal on your computer, navigate to the directory where you want to save the project and run:

    git clone https://github.com/gni/boucle

  3. Navigate to the project directory.

    cd boucle

  4. Create a new branch where you'll work on your contribution. It's good practice to create a new branch for each new feature or fix.

    git checkout -b branch-name

  5. Install Jekyll and any necessary dependencies using Bundler.

    bundle install

Making Changes

  1. Open the project in your preferred text editor and make your changes or additions.

  2. Try to make small, focused commits. Include a detailed commit message.

    git commit -m "commit message"

  3. Push your changes to your forked repository.

    git push origin branch-name

Submitting a Pull Request

  1. Go to your forked repository on GitHub and click the "New Pull Request" button next to your branch.
  2. Write a detailed description of what the Pull Request is about. Attach screenshots if your changes include visual updates.
  3. Wait for the maintainers to review your pull request. They might suggest changes, improvements or ask for clarification about your changes. Be patient and responsive to their feedback.

Code of Conduct

We follow a Code of Conduct, and we expect all contributors to adhere to it. Please check our Code of Conduct before making a contribution.

Remember, all interactions in this project should adhere to the Contributor Covenant Code of Conduct.

Licensing

When you submit code changes, your submissions are understood to be under the same MIT License that covers the project.

Thank you for your contribution!