-
Notifications
You must be signed in to change notification settings - Fork 12
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
0d11d83
commit 61f1c1e
Showing
1 changed file
with
72 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,72 @@ | ||
# Contributing to Job-City | ||
|
||
We are excited that you want to contribute to Job-City! Your contributions can help improve our automated job application platform and enhance the learning experience for all users. This guide outlines the steps to make the contribution process smooth and rewarding for everyone involved. | ||
|
||
## How to Contribute | ||
|
||
### 1. **Fork the Repository** | ||
- Click the **Fork** button on the top right of the repository page to create your copy of the project. | ||
|
||
### 2. **Clone Your Fork** | ||
- Clone your forked repository to your local machine: | ||
|
||
```bash | ||
git clone https://github.com/your-username/jobcity.git | ||
``` | ||
|
||
### 3. **Create a Branch** | ||
- Create a new branch for your feature or bug fix: | ||
|
||
```bash | ||
git checkout -b feature/your-feature-name | ||
``` | ||
|
||
### 4. **Make Changes** | ||
- Make your changes in your branch. Ensure that you follow the project's coding style and conventions. | ||
- Add comments to your code where necessary to improve readability. | ||
### 5. **Test Your Changes** | ||
- Run the application locally to ensure your changes work as expected. Test any new functionality you introduce. | ||
- If applicable, add unit tests to cover your changes. | ||
### 6. **Commit Your Changes** | ||
- Commit your changes with a clear and descriptive message: | ||
```bash | ||
git commit -m "Add a brief description of your changes" | ||
``` | ||
### 7. **Push Your Changes** | ||
- Push your changes to your fork: | ||
```bash | ||
git push origin feature/your-feature-name | ||
``` | ||
### 8. **Open a Pull Request** | ||
- Navigate to the original repository and click on the **Pull Requests** tab. | ||
- Click on the **New Pull Request** button. | ||
- Select your branch from the dropdown and provide a clear description of your changes. | ||
- Submit the pull request. | ||
## Code of Conduct | ||
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). We are committed to making the project welcoming and inclusive for everyone. | ||
## Hacktoberfest Participation | ||
If you are participating in Hacktoberfest, please label your pull requests with `hacktoberfest` to ensure they are counted towards your contributions. | ||
### Hacktoberfest Guidelines: | ||
- Ensure that your contributions are meaningful and add value to the project. | ||
- Avoid making trivial changes (like typos or formatting changes) that do not add substantial value. | ||
- Your contributions must be made in accordance with the guidelines above. | ||
## Additional Resources | ||
- [Next.js Documentation](https://nextjs.org/docs) | ||
- [Tailwind CSS Documentation](https://tailwindcss.com/docs) | ||
- [Framer Motion Documentation](https://www.framer.com/docs/) | ||
- [Monaco Editor Documentation](https://microsoft.github.io/monaco-editor/) | ||
Thank you for your interest in contributing to Job-City! Together, we can build an amazing platform that helps users in their job application journey. |