RevelaNetwork/RevelaOS
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[📚] Added contributing guidelines

Browse source
This commit is contained in:
ThinLiquid 2023-10-17 13:10:14 +01:00
parent 63408d7a4c
commit ad4961b109
2 changed files with 90 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

65
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,65 @@
# Contributing
When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
## Pull Request Process
1. Follow the guidelines for making a commit. If the guidelines aren't followed your pull request will be closed.
2. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
3. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
4. Increase the version numbers in any examples files and the README.md to the new version that this pull request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
5. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.
## Commit Guidelines
| Commit type | Emoji |
|:----------------------------|:----------------------------------------------------------|
| Version tag | :bookmark: `:bookmark:` |
| New feature | :sparkles: `:sparkles:` |
| Bugfix | :bug: `:bug:` |
| Metadata | :card_index: `:card_index:` |
| Documentation | :books: `:books:` |
| Documenting source code | :bulb: `:bulb:` |
| Performance | :racehorse: `:racehorse:` |
| Cosmetic | :lipstick: `:lipstick:` |
| Tests | :rotating_light: `:rotating_light:` |
| Adding a test | :white_check_mark: `:white_check_mark:` |
| Make a test pass | :heavy_check_mark: `:heavy_check_mark:` |
| General update | :zap: `:zap:` |
| Improve format/structure | :art: `:art:` |
| Refactor code | :hammer: `:hammer:` |
| Removing code/files | :fire: `:fire:` |
| Continuous Integration | :green_heart: `:green_heart:` |
| Security | :lock: `:lock:` |
| Upgrading dependencies | :arrow_up: `:arrow_up:` |
| Downgrading dependencies | :arrow_down: `:arrow_down:` |
| Lint | :shirt: `:shirt:` |
| Translation | :alien: `:alien:` |
| Text | :pencil: `:pencil:` |
| Critical hotfix | :ambulance: `:ambulance:` |
| Deploying stuff | :rocket: `:rocket:` |
| Work in progress | :construction: `:construction:` |
| Adding CI build system | :construction_worker: `:construction_worker:` |
| Analytics or tracking code | :chart_with_upwards_trend: `:chart_with_upwards_trend:` |
| Removing a dependency | :heavy_minus_sign: `:heavy_minus_sign:` |
| Adding a dependency | :heavy_plus_sign: `:heavy_plus_sign:` |
| Docker | :whale: `:whale:` |
| Configuration files | :wrench: `:wrench:` |
| NodeJS package.json | :package: `:package:` |
| Merging branches | :twisted_rightwards_arrows: `:twisted_rightwards_arrows:` |
| Bad code / need improv. | :hankey: `:hankey:` |
| Reverting changes | :rewind: `:rewind:` |
| Breaking changes | :boom: `:boom:` |
| Code review changes | :ok_hand: `:ok_hand:` |
| Accessibility | :wheelchair: `:wheelchair:` |
| Move/rename repository | :truck: `:truck:` |
| Issue/Pull Request template | :newspaper_roll: `:newspaper_roll:` |
| Merge pull request | :knot: `:knot:` |
## Code of Conduct
Our Code of Conduct is located at `CODE_OF_CONDUCT.md`

43
README.md
View file

@ -1,39 +1,46 @@
<div align="center">
<img src="https://raw.githubusercontent.com/Flow-Works/FlowOS/main/public/assets/logo.svg" width="100px">
<p style="font-size: 28px; font-weight: bold">Flow OS</p>
<img src="https://img.shields.io/github/stars/flow-works/flowos-2.0?style=for-the-badge" />
<p style="font-size: 28px; font-weight: bold">FlowOS Next</p>
<img src="https://img.shields.io/github/issues-pr/flow-works/flowos-2.0?style=for-the-badge" />
[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)
<img src="https://img.shields.io/github/forks/flow-works/flowos-2.0?style=for-the-badge&color=orange" />
<img src="https://img.shields.io/github/stars/flow-works/flowos-2.0?style=flat" />
<img src="https://img.shields.io/github/issues-pr/flow-works/flowos-2.0?style=flat" />
<img src="https://img.shields.io/github/forks/flow-works/flowos-2.0?style=flat&color=orange" />
<img src="https://img.shields.io/github/commit-activity/t/Flow-Works/FlowOS-2.0?style=flat&color=violet" />
[![build](https://github.com/Flow-Works/FlowOS-2.0/actions/workflows/build.yml/badge.svg)](https://github.com/Flow-Works/FlowOS-2.0/actions/workflows/build.yml)
<img src="https://img.shields.io/github/commit-activity/t/Flow-Works/FlowOS-2.0?style=for-the-badge&color=violet" />
<br><br>
<i>The next generation of Flow OS</i>
<br>
<a href="https://docs.flow-works.me"><strong>Read the docs »</strong></a>
<hr>
<i>The future of Flow OS</i>
<br>
<a href="https://docs.flow-works.me"><strong>Read the docs »</strong></a>
<br>
</div>
## What is Flow OS?
Flow OS is a web OS proxy made for the Titanium Network 2023 Proxathon. It's extremly customizable with an API to make your own apps, themes, and modules.
## Getting Started
To run Flow OS on your local machine, you need Node.js 16 or above.
* Clone the repository
```
git clone https://github.com/flow-works/flowos
```
* Install packages
1. Clone the repository
```bash
git clone https://github.com/Flow-Works/FlowOS-2.0
```
2. Install packages
```bash
npm install
```
* Build and run!
```
npm run build
3. Run!
```bash
npm run serve
```
## Contributing
## Made with
Flow OS is made with the following software:
@ -43,4 +50,4 @@ Flow OS is made with the following software:
* [Ultraviolet](https://github.com/titaniumnetwork-dev/ultraviolet)
## License
Flow OS is licensed under the MIT license. See the `LICENSE` file for more information.
FlowOS is licensed under the MIT license. See the `LICENSE` file for more information.