Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
134 lines (92 loc) · 4.47 KB

CONTRIBUTING.md

File metadata and controls

134 lines (92 loc) · 4.47 KB
Raw

Contributing to Jet Centre

Thank you for your interest in contributing to Jet Centre🚀! We're excited to have your help. Please review the guidelines below to ensure a smooth contribution process.

Table of Contents

  1. Getting started
  2. How to Contribute
  3. Style Guidelines
  4. Commit messages

Getting started

Please refer to the Getting Started Guide to know how to install and launch the project!

How to Contribute

Reporting Issues

If you find a bug or have a question:

  1. Check the issue tracker to see if it’s already reported.
  2. If it’s not listed, open a new issue.
    • Provide a clear description of the issue.
    • Include steps to reproduce the problem.
    • Add screenshots or logs, if applicable.
    • We will answer shortly, please keep in touch!

Issue types

  • Bug: An unexpected problem or behaviour
  • Enhancement: An improvement of an already existing feature
  • New Feature: A request, idea, or new functionnality that wan't in the original project idea
  • Task: A specific functionnality that was part of the original project idea

Issue labels

  • cdp, dirco, intervenant, secgé, tréso, vpo: Issues related with a specific page
  • ★★★✰✰: Difficulty of the issue (1 to 5)
  • Heisenbug: A bug that was reported but that we can't replicate consistantly

Contributing Code

  1. Fork the project.
  2. Create a clone of your forked git repo and add a remote pointing to this repo The remote ensures that your can easily pull more recent changes to your forked repo
git clone https://github.com/<your_username>/jet-centre.git
git remote add upstream https://github.com/Telecom-Etude/jet-centre.git
  1. Read the Getting Started Guide to set up the project locally.
  2. Make your changes, ensuring you follow the Style Guidelines.
  3. Once finished with all your code on your fork, make sure you are up-to-date with the main branch of jet-centre. You can use the following command to merge your changes with the original repo
git pull upstream main
  1. Once finished, make a Pull request with your fork.
    • Provide a clear description of the feature.
      • What the changes are.
      • The motivation behind them.
      • Any related issues.
    • Add screenshots if applicable.
    • We will answer shortly, please keep in touch!

Fork

Fork

Style Guidelines

  • Code Style: Follow Next.js best practices and use ESLint and Prettier.
  • Formatting: Ensure code is formatted using the project's Prettier configuration.
    • If you use vscode, some extensions will be recommended when you install the project: please install them.
    • Otherwise, personally make sure your code is formatted and is correct relatively to the [.prettierrc] and [.eslintrc.json] files.

To format your code using the Prettier configuration, run one of the following command:

Makefile

make fmt

Legacy

bun run fmt

Commit Messages

Follow the Conventional Commits format:

action(scope): what the commit does

See https://www.conventionalcommits.org for more information.

action must (cf. ci in here) be one of these:

  • feat (add a new feature)
  • fix (fix a bug, an issue)
  • chore (update versions, add dependencies, CIs, etc.)
  • docs (add documentation)
  • style (change style)
  • ref / refactor (rewrite some code)
  • perf (improve performance of some code)
  • test (add tests)

action is typically the answer to 'What will this commit do?'

scope is typically the answer to 'Where does this commit make changes?' (some examples of scopes: sigin-page, authentication, github, docs, follow-page, create-page, etc.)

For instance, if you fix the redirection callback on the signin page, a good commit name is

fix(auth): redirection callback on the signin page

Language

The chosen language is British English. All code, documentation and commits must thus be in British English.