-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
57bd14c
commit d162074
Showing
1 changed file
with
47 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,47 @@ | ||
# Contributing Guidelines | ||
|
||
Thank you for your interest in contributing to the Customer Relations Management tool built in the MERN stack! We appreciate your help in making this project better. | ||
|
||
## Features of the App | ||
|
||
The app has three sections: | ||
|
||
### Employer | ||
The employer section allows users to access details about service requests, leads, and contacts. | ||
|
||
### Service Request | ||
The service request section contains details about a service requested from the employer. | ||
|
||
## Contributing Process | ||
|
||
1. Fork the repository. | ||
2. Create a new branch with a descriptive name: | ||
``` | ||
git checkout -b <branch-name> | ||
``` | ||
3. Make changes and ensure that the code is properly formatted. | ||
4. Commit your changes: | ||
``` | ||
git commit -m "A brief description of your changes" | ||
``` | ||
5. Push your changes to the branch: | ||
``` | ||
git push origin <branch-name> | ||
``` | ||
6. Create a pull request. | ||
|
||
## Code Style | ||
|
||
Please follow the code style used in the project. We use the following tools for linting and formatting: | ||
|
||
- ESLint for JavaScript. | ||
|
||
## Issues | ||
|
||
Please check the issues page to see if your issue has already been reported. If not, please create a new issue with a descriptive title and detailed description. | ||
|
||
## Pull Requests | ||
|
||
Please follow the pull request template and provide as much detail as possible. We appreciate your help in making this project better. | ||
|
||
Thank you! |