Thank you for considering contributing to xfrpc! Please follow these steps to submit your contributions:
-
Fork the Repository
Click the "Fork" button on the top right of the repository page to create a copy of the repository in your GitHub account. -
Clone Your Forked Repository
Clone the repository to your local machine using the following command:- Using HTTPS (recommended for users who haven't set up SSH keys):
git clone https://github.com/your_github_username/xfrpc.git
- Using SSH (for users who have set up SSH keys with GitHub):
git clone [email protected]:your_github_username/xfrpc.git
- Using HTTPS (recommended for users who haven't set up SSH keys):
-
Create a New Branch
Create a new branch for your feature or bug fix:git checkout -b "your-feature-name"
-
Make Changes and Test
Implement your changes locally and test them thoroughly to ensure they work as expected. -
Update
contributors.md
Add your name to thecontributors.md
file. -
Commit and Push Your Changes
Commit your changes with a sign-off and push them to your forked repository:git commit --signoff git push origin your-feature-name
-
Create a Pull Request
Open a Pull Request (PR) from your forked repository to the main repository on GitHub and wait for the review process.
-
Sync with the Main Repository: Keep your fork up to date by syncing it regularly with the upstream repository.
git fetch upstream git rebase upstream/master
-
Resolve Merge Conflicts: If conflicts arise during rebase or merging, resolve them before submitting the PR.
Thank you for contributing!