Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
May 16, 2024

Conversation

Rosencrantz
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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

@Rosencrantz
Copy link
Contributor Author

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

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

Rosencrantz and others added 2 commits May 14, 2024 11:38
There needs to be an empty line between the heading and the next paragraph. Otherwise, the markup isn’t rendered correctly.
Copy link
Contributor

@tillprochaska tillprochaska left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed a small issue with the markup (there needs to be an empty line between the heading and the following paragraph, otherwise it doesn’t render correctly).

@tillprochaska tillprochaska merged commit f660281 into develop May 16, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants