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

Contributing Documentation - Testing #5831

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nina-sanchez
Copy link

Hello! I am new to twenty and have been going through the documentation to better understand how to work on issues, contributing guidelines etc. As I was going through it I read that it should be tested locally - but also saw that at times testing suites were provided with the PR. Because of that I created a PR which includes information regarding testing suites when pushing, which are added into the contributing.md file. The image below shows what the section looks like when implemented:

333958135-d50c7202-3f68-4191-aa61-636ea5ed2888

Copy link

Welcome!

Hello there, congrats on your first PR! We're excited to have you contributing to this project.
By submitting your Pull Request, you acknowledge that you agree with the terms of our Contributor License Agreement.

Generated by 🚫 dangerJS against 236b1f1

@charlesBochet
Copy link
Member

charlesBochet commented Jun 25, 2024

Hi @nina-sanchez, thanks for your interest in the project. I think we should be giving more precise instruction on how to tests, rather than diving too much into the why we should add tests which is educational but one sentence should be good enough about it.

I feel we should write something in the documentation instead and add a link to it from here.

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

Successfully merging this pull request may close these issues.

None yet

3 participants