This repository has been archived on 2024-09-12. You can view files and clone it, but cannot push or open issues or pull requests.
svrjs-website/source/contribute.md

41 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2024-03-15 21:53:12 +01:00
---
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 contributions from the community! Here's how you can help:
2024-03-15 21:53:12 +01:00
## Git server details
The Git server runs Forgejo Git hosting package and it's located at https://git.svrjs.org/.
If you have enabled two-factor authentication or logged in via GitHub, generate an access token and use it as a password in Git CLI.
## Reporting Bugs
2024-03-15 21:53:12 +01:00
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.
2024-03-15 21:53:12 +01:00
## Submitting Patches
2024-03-15 21:53:12 +01:00
We accept patches via pull requests. Here's our process:
2024-03-15 21:53:12 +01:00
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.
2024-03-15 21:53:12 +01:00
## Running Tests
2024-03-15 21:53:12 +01:00
Before submitting a pull request, please run the tests to ensure your changes haven't introduced any new issues.
2024-03-15 21:53:12 +01:00
## Documentation
2024-03-15 21:53:12 +01:00
If your contribution changes existing functionality or adds new features, please update the documentation accordingly.
2024-03-15 21:53:12 +01:00
## License
2024-03-15 21:53:12 +01:00
By contributing to our project, you agree that your contributions will be licensed under our project's license.
2024-03-15 21:53:12 +01:00
Thank you for considering contributing to our project!