Skip to content

Commit

Permalink
Merge branch 'main' into TWNTY-6447
Browse files Browse the repository at this point in the history
  • Loading branch information
charlesBochet committed Sep 16, 2024
2 parents 3c395c8 + 31dea49 commit 7d5e1fd
Show file tree
Hide file tree
Showing 679 changed files with 5,473 additions and 9,315 deletions.
2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Twenty's Pledge

The contributors and maintainers of this project pledge to ensure a harassment-free experience for everyone in the community. This commitment applies to individuals of all backgrounds, including age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity, experience, education, socio-economic status, nationality, appearance, race, religion. It also applies to individuals of all sexual identities and orientations.
The contributors and maintainers of this project pledge to ensure a harassment-free experience for everyone in the community.

The focus of both contributors and maintainers is on acting and interacting in ways that promote an open, welcoming, friendly, diverse, inclusive, and healthy community.

Expand Down
59 changes: 17 additions & 42 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,38 @@
# Contributing to Twenty

Thanks for considering contributing to Twenty!

Thank you for considering contributing to Twenty! All community contributions are welcome.

This guide outlines the process for contributing to this project. Please make sure to go through the [documentation](https://docs.twenty.com) before making your contribution.


> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation:
> - Star the project
> - Tweet about it
Please make sure to go through the [documentation](https://docs.twenty.com) before.

<br>


## Getting Started

Good first issues are a great way to start contributing to the project and get familiar with the codebase. Here's how to find them:

1. Visit the "[Issues](https://github.com/twentyhq/twenty/issues)" tab on the main [repository](https://github.com/twentyhq/twenty).
2. Use the "Labels" filter and select "[Good First Issue](https://github.com/twentyhq/twenty/labels/good%20first%20issue)" to see a list of beginner-friendly tasks.
3. Choose an issue that interests you, fork the project, and start working on it. Once you solve and test the issue, open a PR for review.
## Good first issues

Note: We are aware that having multiple contributors address the same issue can cause frustration. To prevent this, we adhere to a specific guideline: if a core team member has assigned an issue to a contributor, either as the issue assignee or through explicit assignment in the issue comments within the past three days, that contributor's pull request takes precedence. Otherwise, the first PR submitted will be given priority. This delay is reduced to one day for PR tagged with "size: minutes" and extended to a week for PR tagged "size: days".
Good first issues are a great way to start contributing and get familiar with the codebase. You can find them on by filtering on the [good first issue](https://github.com/twentyhq/twenty/labels/good%20first%20issue) label.

Therefore, ensure you are assigned to an issue before beginning work on it.
## Issue assignment

<br>
Having multiple contributors address the same issue can cause frustration.

To avoid conflicts, we follow these guidelines:
1. If a core team member assigned you the issue within the last three days, your PR takes priority.
2. Otherwise, the first submitted PR is prioritized.
3. For "size: long" PRs, the assignment period extends to one week.

## Contributing Guidelines
Please ensure you're assigned to an issue before starting work.

## How to Contribute

1. **Fork the Repository:** Click on the 'Fork' button in the upper right corner of the repository's GitHub page. This will create a copy of the repository in your GitHub account.


2. **Clone the Repository:** Clone your forked repository to your local machine using `git clone`.


```shell
git clone https://github.com/yourusername/twenty.git
cd twenty
```

3. **Create a New Branch:** Create a new branch for your changes instead of using the main branch.

```shell
Expand All @@ -56,40 +47,24 @@ git checkout -b your-branch-name

6. **Commit Changes:** Commit your changes with a clear and concise commit message.


```shell
git commit -m "Add your detailed description here"
```
7. **Push Changes:** Push your changes to your forked repository.

7. **Push Changes:** Push your changes to your forked repository.

```shell
git push origin your-branch-name
```

8. **Create a Pull Request:** Go to the original Twenty repository and create a pull request. Please provide a detailed description of your changes. Submitting a PR means you agree to the CLA.

8. **Create a Pull Request:** Go to the original Twenty repository and create a pull request. Please provide a detailed description of your changes. To have your pull request accepted, you must sign a CLA.


9. **Code Review:** Your pull request will undergo a code review. Note that you might need to make any necessary adjustments based on feedback.

9. **Code Review:** Your pull request will undergo a code review.

10. **Merge:** Once approved, maintainers will merge your pull request into the main repository.


<br>

## Code of Conduct

Please note that by contributing to this project, you're expected to follow Twenty's [Code of Conduct](./CODE_OF_CONDUCT.md). All maintainers strive to maintain a welcoming, friendly, and inclusive community for all contributors.

<br>

## Reporting Issues

If you encounter any issues or have suggestions for improvements, please feel free to (create an issue on Twenty's GitHub repository)[https://github.com/twentyhq/twenty/issues/new]. When reporting issues, please provide as much detail as possible to help in understanding and addressing the problem effectively.

---

Thank you for considering contributing to Twenty. Your contributions help make Twenty's CRM platform even better!

If you face any issues or have suggestions, please feel free to (create an issue on Twenty's GitHub repository)[https://github.com/twentyhq/twenty/issues/new]. Please provide as much detail as possible.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ We felt the need for a CRM platform that empowers rather than constrains. We bel

# Demo
Go to <a href="https://demo.twenty.com/">demo.twenty.com</a> and login with the following credentials:

```
email: [email protected]
password: Applecar2025
Expand Down Expand Up @@ -67,6 +68,7 @@ Below are some features we have implemented to date:
+ [Create tasks on records](#create-tasks-on-records)
+ [Navigate quickly through the app using keyboard shortcuts and search](#navigate-quickly-through-the-app-using-keyboard-shortcuts-and-search)


## Add, filter, sort, edit, and track customers:

<p align="center">
Expand Down
2 changes: 2 additions & 0 deletions install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,10 @@ if command -v nc &> /dev/null; then
read -p "Enter a new port number: " new_port
if [[ $(uname) == "Darwin" ]]; then
sed -i '' "s/$port:$port/$new_port:$port/g" docker-compose.yml
sed -E -i '' "s|^SERVER_URL=https://localhost:[0-9]+|SERVER_URL=https://localhost:$new_port|g" .env
else
sed -i'' "s/$port:$port/$new_port:$port/g" docker-compose.yml
sed -E -i'' "s|^SERVER_URL=https://localhost:[0-9]+|SERVER_URL=https://localhost:$new_port|g" .env
fi
port=$new_port
done
Expand Down
2 changes: 0 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
"@aws-sdk/credential-providers": "^3.363.0",
"@blocknote/mantine": "^0.15.3",
"@blocknote/react": "^0.15.3",
"@chakra-ui/accordion": "^2.3.0",
"@chakra-ui/system": "^2.6.0",
"@codesandbox/sandpack-react": "^2.13.5",
"@dagrejs/dagre": "^1.1.2",
"@docusaurus/core": "^3.1.0",
Expand Down
2 changes: 0 additions & 2 deletions packages/twenty-docker/.env.example
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ TAG=latest
PG_DATABASE_HOST=db:5432

SERVER_URL=https://localhost:3000
# Uncoment if you are serving your front on another server than the API (eg. bucket)
# FRONT_BASE_URL=https://localhost:3000

# Use openssl rand -base64 32 for each secret
# ACCESS_TOKEN_SECRET=replace_me_with_a_random_string_access
Expand Down
2 changes: 2 additions & 0 deletions packages/twenty-docker/twenty/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ FROM node:18.17.1-alpine as twenty
# Used to run healthcheck in docker
RUN apk add --no-cache curl jq

RUN npm install -g tsx

COPY ./packages/twenty-docker/twenty/entrypoint.sh /app/entrypoint.sh
RUN chmod +x /app/entrypoint.sh

Expand Down
2 changes: 1 addition & 1 deletion packages/twenty-docker/twenty/entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ if [ "${ENABLE_DB_MIGRATIONS}" = "true" ] && [ ! -f /app/docker-data/db_status ]
echo "Running database setup and migrations..."

# Run setup and migration scripts
NODE_OPTIONS="--max-old-space-size=1500" npx ts-node ./scripts/setup-db.ts
NODE_OPTIONS="--max-old-space-size=1500" tsx ./scripts/setup-db.ts
yarn database:migrate:prod

# Mark initialization as done
Expand Down
29 changes: 29 additions & 0 deletions packages/twenty-emails/src/emails/workflow-action.email.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import { BaseEmail } from 'src/components/BaseEmail';
import { Title } from 'src/components/Title';
import { CallToAction } from 'src/components/CallToAction';

type WorkflowActionEmailProps = {
dangerousHTML?: string;
title?: string;
callToAction?: {
value: string;
href: string;
};
};
export const WorkflowActionEmail = ({
dangerousHTML,
title,
callToAction,
}: WorkflowActionEmailProps) => {
return (
<BaseEmail>
{title && <Title value={title} />}
{dangerousHTML && (
<div dangerouslySetInnerHTML={{ __html: dangerousHTML }} />
)}
{callToAction && (
<CallToAction value={callToAction.value} href={callToAction.href} />
)}
</BaseEmail>
);
};
1 change: 1 addition & 0 deletions packages/twenty-emails/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ export * from './emails/delete-inactive-workspaces.email';
export * from './emails/password-reset-link.email';
export * from './emails/password-update-notify.email';
export * from './emails/send-invite-link.email';
export * from './emails/workflow-action.email';
Loading

0 comments on commit 7d5e1fd

Please sign in to comment.