-
Notifications
You must be signed in to change notification settings - Fork 701
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
60 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# Contribution Guide | ||
Welcome to the RealChar project contribution guide. If you're looking to help, this is a great place to start. Follow these guidelines to help ensure the process is as smooth as possible for both you and the project maintainers. | ||
|
||
# Setup | ||
1. Fork the RealChar repository | ||
2. Clone the fork to your local machine | ||
3. Set the upstream remote to the original RealChar repository | ||
```bash | ||
git clone https://github.com/<your username>/RealChar.git | ||
cd RealChar | ||
git remote add upstream https://github.com/Shaunwei/RealChar.git | ||
``` | ||
|
||
# Making Changes | ||
Before making changes, ensure that you're working with the most recent version of the code: | ||
|
||
```bash | ||
git checkout main | ||
git pull upstream main | ||
``` | ||
|
||
Create a new branch for your changes: | ||
|
||
```bash | ||
git checkout -b <branch-name> | ||
``` | ||
|
||
# Coding Standards | ||
Please adhere to the following: | ||
|
||
1. Follow existing coding style and conventions. | ||
2. Write clear, readable, and maintainable code. | ||
3. Include detailed comments when necessary. | ||
4. Test your changes thoroughly before submitting your pull request. | ||
|
||
# Committing Your Changes | ||
1. Stage your changes: git add . | ||
2. Commit your changes: git commit -m "Your detailed commit message" | ||
3. Push your changes to your fork: git push origin <branch-name> | ||
|
||
# Submitting a Pull Request | ||
1. Navigate to the original RealChar repository | ||
2. Click 'New pull request' | ||
3. Choose your fork and the branch containing your changes | ||
4. Give your pull request a title and detailed description | ||
5. Submit the pull request | ||
|
||
# Issue Tracking | ||
If you're adding a new feature or fixing a bug, make sure to add or update an issue in the issue tracker. If there's not an existing issue, create a new one. This helps us keep track of what needs to be worked on. | ||
|
||
# Code of Conduct | ||
By participating in this project, you're expected to uphold our Code of Conduct. | ||
|
||
# Where to Get Help | ||
If you run into problems or need help, check out our [discord](https://discord.gg/UYeQAUfaAX). | ||
|
||
Thank you for considering contributing to RealChar! Your time and expertise is greatly appreciated by the community. |