Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

47 lines (35 loc) · 2.59 KB
Raw

Contribution Guidelines

Thank you for considering contributing to E-Cell NITS Website repo! We welcome contributions from the community to help improve and fix the bugs. Before you start, please take a moment to review these guidelines to ensure a smooth contribution process.

Table of Contents

Getting Started

  1. Fork the vite_newdev branch to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your work.

Code Style Guidelines

  • We follow the E-Cell Website Repo General Convention for this project. Please review and adhere to these guidelines when writing code.

  • Make use of basic linting, as specified in our documentation to maintain code consistency.

    Issue and Pull Request Workflow

  • Before working on a new feature or bug fix, check the issue tracker for existing issues or feature requests.

  • If the issue does not exist, please open a new issue to discuss your proposed changes.

  • Fork the vite_newdev branch and create a new branch for your work.

  • Reference the issue number in your commit messages and pull request description using #issue_number.

  • Ensure that your pull request includes clear and concise descriptions of your changes.

Testing

  • Make sure your changes in code doesn't alter the existing functionality.

Code Review

  • Pull requests will be reviewed by Maintainers.
  • Address any review comments and make necessary changes to your code.
  • Be patient during the review process, and be open to feedback.

Submitting a Pull Request

  • Make sure your code is up to date with the latest changes from the vite_newdev branch.
  • Squash your commits into a single coherent commit with a clear message.
  • Ensure that your pull request title and description are descriptive and explain the purpose of the changes.
  • Reference any related issues or pull requests in your description.
  • Sign your commits if you have signed the Contributor License Agreement (CLA).
  • Wait for approval from maintainers before merging your pull request.
  • We have a dedicated UI/UX team, so any changes in design, if objected by the team won't be merged.

License

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.