CONTRIBUTING.md

Contributing to Campus-Connect

Thanks for your interest in contributing to Campus-Connect! This document provides guidelines for contributing.

Getting Started

Before you begin:

1. Make sure you have installed Node.js and npm.
2. Fork the Campus-Connect repository.
3. Clone the forked repository to your local machine.
4. Navigate into the project directory: cd Campus-Connect
5. Install the dependencies: npm install

Developing Campus-Connect

Follow these steps to start developing:

1. Create a new branch: git checkout -b <branch_name>
2. Make your changes and test them locally.
3. Commit your changes: git commit -m '<commit_message>'

Submitting Changes

After you've made your changes, you're ready to submit a pull request. Follow these steps:

1. Push your changes to the forked repository: git push origin <branch_name>
2. Navigate to the GitHub page of your forked repository and click on the New pull request button.
3. Ensure the pull request merges the changes from your branch in the forked repository to the main branch in the original repository. Provide a meaningful description for the changes you made.
4. Click on Create pull request.

After Submitting

Once you've created the pull request:

1. A GitHub Action will automatically run to test your changes. Please ensure the test workflow passes. If it fails, review the logs, make necessary changes and commit again.
2. Request a code review from other developers by tagging them in the pull request comments.
3. If the reviewers have suggested changes, make the changes and commit them to your branch.
4. Once your changes have been approved, and there are no conflicts with the base branch, you can merge your pull request into the main branch.

Contact

If you have any questions, feel free to reach out to us at [email protected].

Thank you for your contribution!