svrjs/svrjs-website
Archived
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Replace contribution page with instructions for Forgejo-based Git server

Browse source
This commit is contained in:
Dorian Niemiec 2024-06-22 09:26:22 +02:00
parent 6aa4708c0d
commit 395dd28cf0
1 changed files with 17 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
source/contribute.md
View file

@ -3,58 +3,32 @@ 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.
We welcome contributions from the community! Here's how you can help:
## 1\. Fork the Repository
## Reporting Bugs
Start by forking the SVR.JS repository. Clone it to your local machine using:
If you find a bug, please open an issue on our issue tracker with a detailed description of the problem and steps to reproduce it.
git clone https://git.svrjs.org/svrjs.git
## Submitting Patches
If you want to contribute to other project, e.g. RedBrick SVR.JS mod, replace `svrjs.git` with respective repository name.
We accept patches via pull requests. Here's our process:
## 2\. Create a Feature Branch
1. **Fork** the project.
2. **Create a branch** for your patch.
3. **Commit** your changes with descriptive commit messages.
4. **Push** your branch to your fork.
5. **Open a pull request** against the main repository.
Create a new branch for your changes with a descriptive name. For example:
## Running Tests
git checkout -b feature/your-feature-name
Before submitting a pull request, please run the tests to ensure your changes haven't introduced any new issues.
## 3\. Make Your Changes
## Documentation
Now comes the exciting part! Make the necessary changes, add new features, or fix bugs in your feature branch.
If your contribution changes existing functionality or adds new features, please update the documentation accordingly.
## 4\. Commit
## License
Commit your changes to your forked repository:
By contributing to our project, you agree that your contributions will be licensed under our project's license.
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.**
Thank you for considering contributing to our project!