Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 2.82 KB

contributing.md

File metadata and controls

72 lines (50 loc) · 2.82 KB

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:

    git clone https://github.com/VishwamAI/jobcity.git

3. Create a Branch

  • Create a new branch for your feature or bug fix:

    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:

    git commit -m "Add a brief description of your changes"

7. Push Your Changes

  • Push your changes to your fork:

    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. 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

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.