YunoHost-Apps/flohmarkt_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/flohmarkt_ynh.git synced 2024-09-03 18:36:30 +02:00
Code Issues Activity Actions

DISCLAIMER.md new, edited DEVELOPMENT.md

Browse source
This commit is contained in:
Chris Vogel 2024-04-26 09:39:57 +02:00
parent b27fea1a1c
commit ca8955922d
2 changed files with 42 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
doc/DEVELOPMENT.md
View file

@ -1,8 +1,30 @@
## upstream repository
## flohmarkt lives on codeberg
The yunohost integration of flohmarkt is developed by the flohmarkt organization on https://codeberg.org/ .
The flohmarkt team decided to use https://codeberg.org/ as its home. As we embrace the yunohost integration of **flohmarkt** we want to keep its development close to the core team in a repository under its organisation on Codeberg.
Please refer to https://codeberg.org/flohmarkt/flohmarkt_ynh/ to take part in development.
We acknowledge that this is unusual for an yunohost app and are aware that this decision might lead to problems and additional organizational effort.
But as much as we value yunohost and are willing to accept its decision to live on github we kindly ask everybody to accept and support our decision to organize the flohmarkt project on a different service.
We hope that in the end the proximity between home repository and repository for yunohost integretion will be benefitial. If not there'll always be the option to move the repo completely into the yunohost-apps organization on github.
Your opinion is appreciated on this topic.
## development workflow
**subject to change and discussion - think of this as an RFC**
### development on codeberg
* clone the [repo](https://codeberg.org/flohmarkt/flohmarkt_ynh) on codeberg
* create your working branch
* once done with your changes / additions open a pull request to the main repo
* your request will be reviewed, discussed and probably merged
The codeberg repository is meant to be bleeding edge and we'll try to follow the HEAD of [flohmarkts](https://codeberg.org/flohmarkt/flohmarkt) repository closely.
Once in a while we'll reach the point to tag a new `-ynhX` version for changes of the yunohost integration or we'll want to release a new version of flohmarkt or both.
To do so we'll push the according changes to the [flohmarkt repository at github](https://github.com/YunoHost-Apps/flohmarkt_ynh) to make upgrades available to the yunohost community.
One **pitfall** doing so is that we can't rely on the yunohost CI for testing for our codeberg repository this way. If need'll be and developers would like to use yunohost as their base for active work on flohmarkt we might release another app **flohmarkt-devel_ynh** in future that closely follows the repository we use for development.

17
doc/DISCLAIMER.md Normal file
View file

@ -0,0 +1,17 @@
## support
For questions about running flohmarkt on yunohost please use the [yunohost support matrix channel](https://yunohost.org/en/chat_rooms#help-and-support-chat-roo) or the [forum](https://forum.yunohost.org/t/ynh-flohmarkt-flohmarkt-as-an-app-for-yunohost/28455?u=chrichri).
To get help for **flohmarkt** itself please look at its [wiki](https://codeberg.org/flohmarkt/flohmarkt/wiki), [open an issue](https://codeberg.org/flohmarkt/flohmarkt/issues) with your request or join the [IRC channel flohmarkt](https://web.libera.chat/?nick=GithubGuest?#flohmarkt) on [libera.chat](https://libera.chat/).
## bugs, requesting features
Please use the issue tracker at https://codeberg.org/flohmarkt/flohmarkt_ynh/issues
## upstream repository
The yunohost integration of **flohmarkt** is developed by the flohmarkt organization on https://codeberg.org/ .
Please refer to https://codeberg.org/flohmarkt/flohmarkt_ynh/ to take part in development.
More about development of **flohmarkt**s yunohost integration can be found in [DEVELOPMENT.md](DEVELOPMENT.md)