Create Contribution_Guidelines.md

This commit is contained in:
bhavik-mangla
2025-01-06 14:36:09 +05:30
committed by GitHub
parent 5b193f4dff
commit d3076aef53

View File

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