You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
46 lines
1.6 KiB
46 lines
1.6 KiB
# Contribute to Project X's Document
|
|
|
|
Contributions to Project X's Document are welcome, and we appreciate every Contributor's contribution! You guys make Xray stronger!
|
|
|
|
## Improve Document
|
|
|
|
Document for Project X is hosted on [GitHub](https://github.com/XTLS/Xray-docs-next).
|
|
|
|
You can submit your changes to the Document by following these steps:
|
|
|
|
1. Open the repository from [Project X Document](https://github.com/XTLS/Xray-docs-next), click fork in the upper right corner, fork a mirror image of the document repository to your own GitHub repository.
|
|
|
|
2. Get a clone of the docs from the repository you cloned using whatever tool you like, like:
|
|
|
|
```
|
|
git clone https://github.com/XTLS/Xray-docs-next.git
|
|
```
|
|
|
|
3. Create a new branch based on the main branch, such as:
|
|
|
|
```
|
|
git checkout -b your-branch
|
|
```
|
|
|
|
4. Make changes on the new branch.
|
|
|
|
5. After modification, please use [Prettier](https://prettier.io/docs/en/install.html)Format your changes.
|
|
|
|
Note: Pull requests with formatting issues may be rejected.
|
|
|
|
6. Submit the changes and push them to your repository
|
|
|
|
```
|
|
git push -u origin your-branch
|
|
```
|
|
|
|
6. Open GitHub, click 'Pull request' to submit a pull request to [Project X Document](https://github.com/XTLS/Xray-docs-next).
|
|
|
|
7. Please outline the new/modified content of this pull request in the title and body of the pull request;
|
|
|
|
8. Waiting for a response, if the pull request is merged, your changes will be directly displayed on [Project X Document Website](https://xtls.github.io).
|
|
|
|
## Found Problems?
|
|
|
|
If you find an error in the document, you can improve the documentation or submit an issue.
|