60 lines
2.4 KiB
Markdown
60 lines
2.4 KiB
Markdown
---
|
|
title: Contributing to SVR.JS
|
|
date: 2024-01-01 18:29:17
|
|
excerpt: Contribute to SVR.JS and be part of an exciting open-source project. Follow the step-by-step guidelines to fork the repository, create feature branches, and make your code contributions. Submit your patches for review and integration, and collaborate with the SVR.JS community of developers. Your contributions matter — start making an impact today!
|
|
---
|
|
**We welcome your contributions to SVR.JS!** By following these steps, you can submit your changes for review and potential integration into the SVR.JS codebase.
|
|
|
|
## 1\. Fork the Repository
|
|
|
|
Start by forking the SVR.JS repository. Clone it to your local machine using:
|
|
|
|
git clone https://git.svrjs.org/svrjs.git
|
|
|
|
If you want to contribute to other project, e.g. RedBrick SVR.JS mod, replace `svrjs.git` with respective repository name.
|
|
|
|
## 2\. Create a Feature Branch
|
|
|
|
Create a new branch for your changes with a descriptive name. For example:
|
|
|
|
git checkout -b feature/your-feature-name
|
|
|
|
## 3\. Make Your Changes
|
|
|
|
Now comes the exciting part! Make the necessary changes, add new features, or fix bugs in your feature branch.
|
|
|
|
## 4\. Commit
|
|
|
|
Commit your changes to your forked repository:
|
|
|
|
git add .
|
|
git commit -m "Your commit message"
|
|
|
|
## 5\. Generate Patches
|
|
|
|
Before submitting your changes, generate patches using `git format-patch`:
|
|
|
|
git format-patch -n HEAD^
|
|
|
|
This creates patch files (usually ending with .patch) for each commit in your branch.
|
|
|
|
## 6\. Submit Your Patches
|
|
|
|
Email your patches to _commit[at]svrjs[dot]org_ along with the following details:
|
|
|
|
* A clear description of your changes and their purpose.
|
|
* The commit ID from which you cloned the SVR.JS (or other) repository (e.g., the latest commit in your fork).
|
|
* The repository you want to contribute to (if not added, then it's assumed it's SVR.JS repository).
|
|
|
|
Please note the following:
|
|
|
|
* Maximum attachment size: 25MB
|
|
* Compress large patches in .zip, .7z, .tar.gz, or .tar.xz format.
|
|
|
|
## 7\. Code Review and Integration
|
|
|
|
The SVR.JS authors will review your code and provide feedback as needed. They may suggest improvements or ask for clarifications during the review process.
|
|
|
|
If your changes align with the project's goals and coding standards, they may be integrated into the SVR.JS codebase. Your contributions will be acknowledged and celebrated!
|
|
|
|
**Thank you for contributing to SVR.JS! Your efforts play a vital role in making the project better for everyone.**
|