feat: initial commit

This commit is contained in:
2024-06-02 02:26:41 +03:00
commit d10713ad29

39
README.md Normal file
View File

@@ -0,0 +1,39 @@
# Resultium Public Gitea Organization
Welcome to the Resultium Public Gitea organization! This space hosts our public data - open source projects and branding materials. Below you'll find information on our projects and how you can engage with them.
## Featured Projects
- [**number-to-words**](https://git.resultium.net/public/number-to-words): a lightweight number to words conversion library supporting Latvian locale
- [**rcz**](https://git.resultium.net/public/rcz): commit standardization library
- [**branding**](https://git.resultium.net/public/branding): Resultium branding materials
## Contributing
**Please do not use platforms like GitHub to host derivative works or forks of our projects as [GitHub are believed to be violating project licenses during their AI training](https://www.finnegan.com/en/insights/articles/insights-from-the-pending-copilot-class-action-lawsuit.html)**
We follow open-source closed-commit philosophy, meaning you are free to read our code, however we do not allow committing *directly*, in order to prevent vandalism and grief. You are still encouraged to contribute by creating patch files and sending them to our contributions email, instructions are available below.
1. Clone a repository with `git clone`
2. Setup the project, instructions are generally available at project's README
3. Make changes and commit complying with [Conventional Commits standard](https://www.conventionalcommits.org/en/v1.0.0/) or by simply using [rcz](https://git.resultium.net/public/-/packages/npm/@resultium%2Frcz)
4. Use [`git format-patch`](https://git-scm.com/docs/git-format-patch) to generate patch files for commits you want to share with us, e.g.
```bash
# Generates patch files for three latest commits
git format-patch -3
```
5. Email patch files to [contributing@resultium.io](mailto:contributing@resultium.io)
## Reporting Issues
If you find any issues or have suggestions, email us at [bugs@resultium.io](mailto:bugs@resultium.io). We will create an issue in the respective repository and resolve the bug promptly. If you wish to, we can also include reporter credits as a commit footer, e.g. `Reported-by: John Doe (jdnick) <j.doe@email.com>`.
## License
Each project may have its own license. Please check the LICENSE file in each repository for details. Generally we stick to GPLv3 as we believe contributing back is a major part of open-source philosophy.
## Contact
For any questions or additional information, reach out to us at [contributing@resultium.io](mailto:contributing@resultium.io).
Thank you for visiting the Resultium Public Gitea organization! We appreciate your interest in our projects.