Skip to content

Latest commit

 

History

History
62 lines (33 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

62 lines (33 loc) · 1.79 KB
Raw

Contributing Guidelines

Thank you for considering contributing to the Open Source Club Recruitment Web App! We welcome contributions from the community to help improve and enhance our project. Before you start contributing, please take a moment to review the following guidelines.

Getting Started

  1. Fork the repository and clone it to your local machine:

    bash git clone https://github.com/OpenSourceVITB/RecruitmentWebApp.git

  2. Install the project dependencies:

    bash pip install -r requirements.txt

  3. Create a new branch for your changes:

    bash git checkout -b feature/your-feature-name

Making Changes

  • Ensure your code follows the existing coding style and conventions.
  • Test your changes thoroughly to avoid introducing new issues.

Commit Guidelines

  • Write clear, concise commit messages.
  • Use present tense and imperative mood (e.g., "Add feature" instead of "Adding feature").
  • Reference relevant issues in your commit messages.

Submitting a Pull Request

  1. Push your changes to your fork:

    bash git push origin feature/your-feature-name

  2. Create a pull request from your branch to the main repository.

  3. Provide a clear and descriptive title for your pull request.

  4. Include detailed information about your changes in the description.

  5. Reference any relevant issues or pull requests.

Code of Conduct

Please adhere to our Code of Conduct when contributing to this project.

License

By contributing to this project, you agree that your contributions will be licensed under the GNU General Public License v3.0.

If you have any questions or need assistance, feel free to contact us at opensource@vitbhopal.ac.in.

Thank you for your contribution!