From 481a1e4a5f788c59a9b30cc56aa645397e54331a Mon Sep 17 00:00:00 2001 From: Bastien MONTOIS Date: Mon, 13 Nov 2023 10:18:05 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20add=20CONTRIBUTING.md=20?= =?UTF-8?q?to=20provide=20guidelines=20for=20potential=20contributors?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit adds a CONTRIBUTING.md file to the project. This file provides guidelines for potential contributors, including how to get started, how to make a contribution, how to report bugs, and how to suggest enhancements. It also includes a link to the project's Code of Conduct. --- CONTRIBUTING.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..82d59ca --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,61 @@ +# Contributing to colissimo-pickup-point + +First off, thank you for considering contributing to colissimo-pickup-point! It's people like you that make the open source community such a great community! + +## Getting started + +Before you begin: + +- Ensure you have installed the latest version of [Node.js](https://nodejs.org/en/). +- Read the documentation and familiarize yourself with the project. + +## How to make a contribution + +### Fork the Repository + +Create your own fork of the code. + +### Create a Branch + +Create a branch in your fork for your changes. + +### Make Your Changes + +Make your changes and commit them to your branch. Be sure to write detailed commit messages and follow any coding conventions already in place. + +### Write or Adapt Tests + +If you're adding new functionality, please include tests that cover the new code. +If you're fixing a bug, consider adding a test that would have caught the bug. + +### Run the Tests + +Ensure the full test suite passes after your changes. + +### Lint Your Code + +Make sure your changes adhere to any linter rules that are set up. + +### Send a Pull Request + +Push your branch to your fork and open a pull request against the main repository. +Clearly describe the problem and solution. Include the relevant issue number if applicable. + +### Review Process + +The maintainers of the project will review your changes. Be open to feedback and any requests for modifications. + +## Reporting Bugs + +- Use the issue tracker to report bugs. +- Describe the bug and include specific details to help us understand the problem. +- Include steps to reproduce the issue. + +## Suggesting Enhancements + +- Use the issue tracker to suggest enhancements. +- Describe your idea and how it would benefit the project. + +## Code of Conduct + +Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.