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

No guidance regarding which branch to clone in local setup guide #7567

Open
3 tasks done
mjk22071998 opened this issue Feb 19, 2025 · 4 comments
Open
3 tasks done

No guidance regarding which branch to clone in local setup guide #7567

mjk22071998 opened this issue Feb 19, 2025 · 4 comments
Labels

Comments

@mjk22071998
Copy link

⚠️ This issue respects the following points: ⚠️

  • This is a bug, not a question or a configuration/webserver/proxy issue.
  • This issue is not already reported on Github (I've searched it).
  • I agree to follow Monica's Code of Conduct.

Bug description

The project's documentation does not specify which branch is used for development. Additionally, there are no instructions or commands for cloning the repository, which makes it difficult for new contributors to get started.

Steps to reproduce

  1. Visit the project’s setup guide
  2. Scroll down to the steps to setup locally.
  3. Notice the absence of guidance.

Expected behavior

  • The documentation should explicitly state the active development branch.
  • Include a git clone command (e.g., git clone https://github.com/username/repo.git) in the setup guide.

Environment

app.monicahq.com (monica v4)

Version of Monica

No response

Installation method

None

Web server

None

Database engine version

None

Additional info

No response

@iam-subho
Copy link

Image

They have mentioned in homepage that main branch is for developement

@mjk22071998
Copy link
Author

Yeah but in documentation there has to be a git clone command

@Marcos5399
Copy link

Hi @mjk22071998 ,

I completely agree with you regarding the lack of clear documentation on how to clone the repository. To help improve this, I have submitted a Pull Request that enhances the project's documentation, which you might find useful.

Additionally, if you're looking for the cloning instructions in the original project, they can be found in the 4.x branch under this path:
🔗 Installation Guide - Cloning the Repository

Regarding the documentation on branches, while I agree that more details could be provided, it is worth noting that at the beginning of the README, it is mentioned that main is a development branch and that the stable branch for deployment is 4.x, as was already pointed out in a previous comment.

Let me know if you have any thoughts or suggestions! 😊

@mjk22071998
Copy link
Author

Thank you for your response! I really appreciate the effort you put into improving the documentation. This is exactly what I was looking for.

I do know how to clone, but it took me some extra time. That extra time and effort could have been easily saved if the git clone command was included in the documentation. That’s why I created this issue—so others don’t face the same challenge.

Your Pull Request is definitely helpful, and I’m glad to see improvements being made! Thanks again for your support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants