-
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.
Add contributing guidelines for the Job Hunt Project - Included Code of Conduct link - Detailed steps for getting started, submitting issues, and creating pull requests - Added sections on code standards, documentation, and review process - Provided contact information and licensing details
- Loading branch information
Showing
1 changed file
with
44 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,44 @@ | ||
## Contributing Guidelines for Job Hunt Project | ||
|
||
Welcome to the Job Hunt Project! We appreciate your interest in contributing. Please follow these guidelines to help us maintain a high-quality project. | ||
|
||
### Code of Conduct | ||
|
||
We are committed to creating a welcoming and inclusive environment for everyone. Please adhere to our [Code of Conduct](link) and report any issues or concerns to [munaf6007@gmail.com](mailto:munaf6007@gmail.com). | ||
|
||
### How to Contribute | ||
|
||
1. **Getting Started**: | ||
- Fork the repository and clone it to your local machine. | ||
- Install the required dependencies by running `npm install` or `yarn install`. | ||
- Follow the setup instructions in the [README](link) to get the project running locally. | ||
|
||
2. **Submitting Issues**: | ||
- Check if your issue has already been reported by searching the [issue tracker](link). | ||
- If not, create a new issue with a descriptive title and detailed information about the problem or enhancement. | ||
|
||
3. **Creating Pull Requests**: | ||
- Create a new branch for your changes (e.g., `feature/add-job-filter`). | ||
- Ensure your code adheres to our [code style guide](link) and includes tests where applicable. | ||
- Submit a pull request with a clear description of the changes and reference any related issues. | ||
|
||
### Code Standards | ||
|
||
- **Style Guide**: Follow the [JavaScript Style Guide](link) for coding conventions. | ||
- **Testing**: Write unit tests for new features and ensure all tests pass before submitting a PR. | ||
|
||
### Documentation | ||
|
||
- Update documentation in the `docs/` directory with any changes you make to the project. | ||
- Ensure that all new features and changes are documented clearly. | ||
|
||
### Review Process | ||
|
||
- All pull requests will be reviewed by project maintainers. | ||
- Feedback will be provided via comments on the pull request. | ||
- Address all feedback and make necessary changes before the PR can be merged. | ||
|
||
### Additional Information | ||
|
||
- **Licensing**: This project is licensed under the [MIT License](link). | ||
- **Contact**: For any questions or additional information, please reach out to [munaf6007@gmail.com](mailto:munaf6007@gmail.com). |