-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 docs: add CONTRIBUTING.md to provide guidelines for potential contr…
…ibutors 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.
- Loading branch information
Showing
1 changed file
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |