search

alephdata / aleph

Search and browse documents and data; find the people and companies you look for.
http://docs.aleph.occrp.org
MIT License
2k stars 267 forks source link

Added a small amount of text for people looking to get started but are not aware of gitflow #3707

Closed Rosencrantz closed 3 months ago

Rosencrantz commented 4 months ago

Added a reference and link to further information on Gitflow. Also added a small link from the README file to the contributing file so people know where to look when getting started with Aleph develolpment.

tillprochaska commented 4 months ago

I’d suggest to add the following code at the very beginning of the readme to clarify that the default branch contains unreleased code.

⚠️ **IMPORTANT** ⚠️ The default branch in this GitHub repository is "develop". The develop branch contains unreleased, unstable code. For stable releases, please check out the `list of releases <https://github.com/alephdata/aleph/releases>`_ or switch to the `main branch <https://github.com/alephdata/aleph/tree/main>`_.

----
tillprochaska commented 4 months ago

@Rosencrantz Would you mind elaborating what the 😕 emoji means? ;)

Rosencrantz commented 4 months ago

@Rosencrantz Would you mind elaborating what the 😕 emoji means? ;)

It makes me sad that we have to pitch things at this level.