Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create workflow.md #6

Merged
merged 1 commit into from
Oct 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions workflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Project Workflow Guide

This document outlines the workflow process for contributing to this project. Please follow these steps to ensure smooth collaboration and code integration.

### 1. Create a New Branch
Before making any changes, use an existing branch or create one from the `main` branch.

### 2. Sync with Main
Before starting any work, always pull the latest changes from main to ensure your branch is up to date and avoid merge conflicts later.
1. git checkout main
2. git pull origin main
3. checkout your-branch-name
4. merge main

### 3. Make your Changes
Once your branch is up to date, make the necessary changes. Be sure to test your code thoroughly to ensure it runs as expected.

### 4. Commit and Push Changes
After making and testing your changes, commit them with a meaningful message and push them to your remote branch.

### 5. Open a Pull Request
Once your changes are pushed, open a Pull Request (PR) from your branch to the main branch. Ensure the PR description clearly explains the changes and includes any relevant details.

1. Navigate to the repository on GitHub.
2. Click the "Compare & pull request" button for your branch.
3. Review the changes and resolve any merge conflicts if they exist.
4. Submit the pull request.