Spaces:
Build error
Build error
File size: 2,062 Bytes
babeaf6 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# 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.
|