From d3076aef53f63dff69a3afba3e23da8a82ef98ba Mon Sep 17 00:00:00 2001 From: bhavik-mangla <92915999+bhavik-mangla@users.noreply.github.com> Date: Mon, 6 Jan 2025 14:36:09 +0530 Subject: [PATCH] Create Contribution_Guidelines.md --- Contribution_Guidelines.md | 40 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 Contribution_Guidelines.md diff --git a/Contribution_Guidelines.md b/Contribution_Guidelines.md new file mode 100644 index 0000000..b36e4b6 --- /dev/null +++ b/Contribution_Guidelines.md @@ -0,0 +1,40 @@ +## Steps to Set Up Open Peer Chat + +1. **Fork the Repository** + - Navigate to the [Open Peer Chat GitHub Repository](https://github.com/AOSSIE-Org/OpenPeerChat-flutter). + - Click the **Fork** button in the top-right corner to create your own copy of the repository. + +2. **Clone Your Forked Repository** + ```bash + git clone https://github.com/YOUR_USERNAME/OpenPeerChat-flutter.git + cd OpenPeerChat-flutter + ``` + +3. **Make Your Changes** + - Modify the code to implement the required feature or resolve the issue. + +4. **Commit Your Changes** + - Stage your changes and commit them with a meaningful message. + ```bash + git add . + git commit -m "Add: Brief description of your update" + ``` + +5. **Push Your Changes** + - Push your changes to your forked repository. + ```bash + git push origin main + ``` + +6. **Create a Pull Request** + - Go to your forked repository on GitHub. + - Click the **Compare & Pull Request** button. + - Add a detailed description of the changes you made. + - Include a link to a demo video showcasing the feature you added or the issue you resolved. + - Submit the pull request for review. + +### Additional Notes +- Contributors should make changes directly to the `main` branch of their forked repository. +- Ensure that your code adheres to the project’s coding standards and passes all necessary tests before creating a pull request. +- Provide a clear and concise description of your changes in the pull request, along with screenshots or video demonstrations if applicable. +- Keep your forked repository up-to-date with the latest changes from the `main` branch to avoid conflicts.