Skip to content

Commit

Permalink
Mejoras en la documentación del README.md y nuevo archivo BRANCHES.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
Marcos5399 committed Mar 5, 2025
1 parent 8362925 commit 6700eb1
Show file tree
Hide file tree
Showing 2 changed files with 181 additions and 0 deletions.
136 changes: 136 additions & 0 deletions BRANCHES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
# Branch Documentation for Monica Personal CRM

This file documents the most active branches in the Monica Personal CRM repository
(https://github.com/monicahq/monica), based on information provided by the project's
codebase. It details the purpose and usage of each branch.

-----------------------------------------------------------------------------------------

## 1. Main Branches

### main
- **Description**: This is the primary branch of the project (default branch) and contains
the active development code. New features and improvements are integrated here before
being released in a stable version.
- **Usage**: If you wish to contribute to the development of new features, you should
work on the `main` branch.
- **Warning**: This branch is not always stable, as it may contain changes that are still
under development and not fully tested.

### 4.x
- **Description**: This branch is dedicated to the 4.x version of the project and is
considered the current stable release. Users looking for a reliable and tested version
of Monica should use this branch.
- **Usage**: If your goal is to improve the current stable version or deploy it in your
environment, the `4.x` branch is the most appropriate. It is the recommended version
for production environments and receives maintenance and security updates.

-----------------------------------------------------------------------------------------

## 2. Dependabot Branches

Dependabot is an automated tool that keeps the project's dependencies up to date. The
following active branches are related to Dependabot and correspond to updates of specific
packages. These branches are automatically generated by the bot and are usually deleted
once the updates are merged into the main or stable branches.

### dependabot/npm_and_yarn/eslint-config-prettier-10.0.2
- **Purpose**: Update `eslint-config-prettier` to version 10.0.2 to maintain compatibility
with coding standards.

### dependabot/npm_and_yarn/prettier-3.5.3
- **Purpose**: Update `prettier` to version 3.5.3, a code formatting tool.

### dependabot/composer/laravel-lang/common-6.6.0
- **Purpose**: Update the `laravel-lang/common` package to version 6.6.0, which handles
translations in Laravel.

### dependabot/composer/barryvdh/laravel-ide-helper-3.5.5
- **Purpose**: Update the `laravel-ide-helper` package, which improves compatibility with
development tools in Laravel.

### dependabot/composer/laravel/scout-10.13.1
- **Purpose**: Update `laravel/scout` to version 10.13.1, used for search integration in
Laravel.

### dependabot/composer/inertiajs/inertia-laravel-2.0.1
- **Purpose**: Update the `inertia-laravel` package to version 2.0.1, which facilitates
communication between Laravel and frontend frameworks like Vue or React.

### dependabot/composer/laravel/framework-11.43.2
- **Purpose**: Update the Laravel core to version 11.43.2.

-----------------------------------------------------------------------------------------

## 3. Other Active Branches

In addition to the branches managed by Dependabot, there are other active branches related
to the development of new features or fixes.

### 20250223-addressType
- **Purpose**: This branch is under development and is related to the implementation or
improvement of address type handling in the application. It is 5 commits ahead of the
base branch and 1 commit behind, suggesting that tests or adjustments are being made
before integration into a stable branch.

### asbiin-patch-1
- **Purpose**: This branch was created by an external contributor (asbiin) to make a
specific adjustment or fix. It is likely temporary and will be deleted once the changes
are merged into the main branch.

### architecture
- **Purpose**: This branch focuses on the restructuring and improvement of the codebase's
architecture. The main goal is to refactor and optimize the project's structure to
improve maintainability, scalability, and performance.
- **Changes**: Modifications may include directory reorganization, design pattern
improvements, dependency updates, and the implementation of better development practices.
- **Note**: Changes in this branch are aimed at internal code improvements and may not
introduce new user-facing features.

### beta
- **Purpose**: The beta branch is considered a preliminary version that may contain bugs
and is intended for testing and community feedback. Users looking for a more stable
experience should use the main branch or officially released versions.

-----------------------------------------------------------------------------------------

## 4. Branch Naming Conventions

We have observed various naming conventions for branches in this project. While some of
these conventions are outdated, it is worth documenting them for future reference.

### feat/
- **Meaning**: This prefix is used for branches that implement new features or
functionalities.
- **Example**: `feat/add-gunther-2019-01-29`.
- **Purpose**: Develop a new feature, such as a module, page, or significant improvement
in the application.
- **Usage**: When working on something that adds new value to the project.

### fix/
- **Meaning**: This prefix is used for branches that fix bugs or errors in the code.
- **Example**: `fix/sqlexport-2019-12-07`.
- **Purpose**: Resolve specific issues reported in the repository or identified during
development.
- **Usage**: When fixing an existing problem in the code.

### test/
- **Meaning**: This prefix is used for branches related to testing.
- **Example**: `test/add-var-2019-12-07`.
- **Purpose**: Add, improve, or run unit, integration, or end-to-end tests.
- **Usage**: When working on test coverage or fixing existing tests.

-----------------------------------------------------------------------------------------

## 5. Invitation to Contribute

We welcome contributions to this document! If you have additional information about active
branches, naming conventions, or any other details related to the project's branches,
please feel free to add them below. Your input will help improve the documentation and
make it more useful for the community.

[Add your contributions here]

-----------------------------------------------------------------------------------------

End of document.
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
- [Contribute](#contribute)
- [Contribute as a community](#contribute-as-a-community)
- [Contribute as a developer](#contribute-as-a-developer)
- [Branch Overview](#branch-overview)
- [Principles, vision, goals and strategy](#principles-vision-goals-and-strategy)
- [Principles](#principles)
- [Vision](#vision)
Expand All @@ -44,6 +45,8 @@
- [Patreon](#patreon)
- [Contact](#contact)
- [Team](#team)
- [Next Updates](#next-updates)
- [Chandler](#chandler-the-next-evolution-of-monica)
- [Thank you, open source](#thank-you-open-source)
- [License](#license)

Expand Down Expand Up @@ -103,13 +106,30 @@ Here are some of the things you can do to help.

### Contribute as a developer

- How to [clone git repository](https://github.com/monicahq/monica/blob/4.x/docs/installation/providers/generic.md#1-clone-the-repository)
- Read our [Contribution Guide](https://docs.monicahq.com/developers/contribution-guide).
- Install [the developer version locally](https://docs.monicahq.com/developers/setup-local-development) so you can start contributing.
- Look for [issues labelled ‘Bugs’](https://github.com/monicahq/monica/issues?q=is%3Aopen+is%3Aissue+label%3Abug) if you are looking to have an immediate impact on Monica.
- Look for [issues labelled ‘Help Wanted’](https://github.com/monicahq/monica/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). These are issues that you can solve relatively easily.
- Look for [issues labelled ’Good First Issue’](https://github.com/monicahq/monica/labels/good%20first%20issue). These issues are for people who want to contribute, but try to work on a small feature first.
- If you are an advanced developer, you can try to tackle [issues labelled ‘Feature Requests’](https://github.com/monicahq/monica/issues?q=is%3Aopen+is%3Aissue+label%3A%22feature+request%22). These are harder to do and will require a lot of back-and-forth with the repository administrator to make sure we are going to the right direction with the product.

## Command to clone the git repository

> git clone https://github.com/monicahq/monica.git
### Branch Overview

In this project, we use several branches to organize development and contributions. Each branch has a specific purpose, whether for new features, bug fixes, testing, or architectural improvements.

For a detailed description of active branches and their purpose, please refer to the [BRANCHES.txt](https://github.com/monicahq/monica/blob/main/BRANCHES.txt) document. This file provides up-to-date information about:

- **Main branches**: Such as `main` and `4.x`, which contain the development code and stable releases.
- **Dependabot branches**: Automated dependency updates.
- **Other active branches**: Such as `architecture`, which focuses on structural improvements to the project.

We invite you to contribute and use the appropriate branches based on the type of changes you want to make!

## Principles, vision, goals and strategy

We want to use technology in a way that does not harm human relationships, unlike big social networks.
Expand Down Expand Up @@ -173,6 +193,31 @@ Our team is made of two core members:

We are also fortunate to have an amazing [community of developers](https://github.com/monicahq/monica/graphs/contributors) who help us greatly.


## Next updates

### Chandler: The Next Evolution of Monica
After 18 months of development, we have launched the beta version of our new Monica release, called Chandler. This version represents a complete reinvention of Monica, built from the ground up to offer a more robust, flexible, and personalized experience.

**Key Features of Chandler**
- Extensive Customization: Chandler allows you to tailor almost every aspect of the platform, from the interface design to the modules you enable and the data you choose to track.
. New Design & Dark Mode: We've introduced a completely revamped interface along with the highly requested dark mode to enhance the user experience.
- Open Source & Self-Hosted: Chandler remains open source and can be deployed on your own servers for free using Docker or manual installation via the command line.

**Current Limitations of the Beta Version**
- Separate Login System: Monica credentials cannot be used to log into Chandler.
- No Data Migration: Currently, importing data from previous Monica versions is not supported.
- No Bulk Contact Import: The ability to import contacts in bulk is not yet available.
- No API Support: Chandler does not yet provide an API for integrations.

We invite all users to try Chandler during this beta phase and share feedback to help us refine it before the official release.

🔗 Access the beta version here: [Chandler on GitHub](https://github.com/monicahq/chandler)

We greatly appreciate your support and hope you enjoy the improvements Chandler brings!



## Thank you, open source

Monica makes use of numerous open-source projects and we are deeply grateful. We hope that by offering Monica as a free, open-source project, we can help others in the same way these programs have helped us.
Expand Down

0 comments on commit 6700eb1

Please sign in to comment.