changes as per vale warnings (#2353)

* changes as per vale warnings

* changes acc to feedback
This commit is contained in:
Nimra Ahmed
2023-11-07 15:39:29 +05:00
committed by GitHub
parent 7623e7b7f9
commit 398a8d732d
36 changed files with 230 additions and 243 deletions

View File

@ -1,29 +1,22 @@
# Contributor Code of Conduct
## Our Pledge
## Twenty's Pledge
As contributors and maintainers of this project, we pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
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.
We pledge to act and interact in ways that contribute to an open, welcoming, friendly,
diverse, inclusive, and healthy 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.
## Our Standards
## Twenty's Standards
Examples of behavior that contributes to a positive environment for our
Examples of behavior that contributes to a positive environment for this
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Respectfully giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
* Respectfully giving and accepting constructive feedback
* Accepting responsibility and apologizing to those affected by mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
* Focusing on what's best, not just for each individual but also for the community
Examples of unacceptable behavior include:
@ -34,36 +27,29 @@ Examples of unacceptable behavior include:
* The use of aggressive language
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
* Other conduct inappropriate in a professional setting.
## Enforcement Responsibilities
Community leaders and maintainers of this repository are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders and maintainers of this repository are responsible for clarifying and enforcing Twenty's standards of acceptable behavior. They will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders and maintainers of this repository have the right and responsibility to remove, edit, or reject
comments, commits, code, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
Community leaders and maintainers of this repository have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that aren't aligned with this Code of Conduct. They will also communicate reasons for moderation decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
Examples of representing this community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
This Code of Conduct is an adaption of the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
Community Impact Guidelines draw inspiration from [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org

View File

@ -1,10 +1,12 @@
# Contributing to Twenty
Thank you for considering contributing to Twenty! We welcome all types of contributions from the community to help us build and improve our open-source CRM platform. This guide outlines the process for contributing to our project. Please make sure to go through the [documentation](https://docs.twenty.com) before making your contribution.
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, which we would also be very happy about:
> 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
@ -16,9 +18,9 @@ Thank you for considering contributing to Twenty! We welcome all types of contri
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 our [repository](https://github.com/twentyhq/twenty).
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 and we'll review it.
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.
<br>
@ -38,7 +40,7 @@ cd twenty
```
3. **Make Changes:** Make your desired changes and ensure that your code adheres to our coding standards.
3. **Make Changes:** Make your desired changes and ensure that your code adheres to Twenty's coding standards.
4. **Test Locally:** Test your changes locally to ensure they work as expected.
@ -58,28 +60,28 @@ git push origin branch-name
```
7. **Create a Pull Request:** Go to the original Twenty repository and create a pull request. Please provide a detailed description of your changes. To accept your pull request, we need you to sign a CLA.
7. **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.
8. **Code Review:** Your pull request will undergo a code review. Be prepared to make any necessary adjustments based on feedback.
8. **Code Review:** Your pull request will undergo a code review. Note that you might need to make any necessary adjustments based on feedback.
9. **Merge:** Once your pull request is approved, it will be merged into the main repository.
9. **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 are expected to follow our [Code of Conduct](./CODE_OF_CONDUCT.md). We strive to maintain a welcoming, friendly, and inclusive community for all contributors.
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 our GitHub repository)[https://github.com/twentyhq/twenty/issues/new]. When reporting issues, please provide as much detail as possible to help us understand and address the problem effectively.
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 us make our CRM platform even better!
Thank you for considering contributing to Twenty. Your contributions help make Twenty's CRM platform even better!

26
.github/SECURITY.md vendored
View File

@ -2,27 +2,27 @@
## Reporting a Vulnerability
We strongly encourage reporting any potential vulnerabilities.
Reporting any potential vulnerabilities is strongly encouraged.
If you suspect a vulnerability, please take the following steps:
- Contact us immediately at `security at twenty.com`.
- Include a comprehensive description of the potential vulnerability and steps to reproduce the issue, if possible. The more information you can provide, the quicker we can address the problem.
- Contact the team at `security at twenty.com`.
- Include a comprehensive description of the potential vulnerability and steps to reproduce the issue, if possible. The more information you can provide, the quicker Twenty can address the problem.
Our commitment is to respond to your initial report within one business day.
While we're addressing the issue, we kindly request you to maintain confidentiality about the vulnerability to ensure the security of all users.
You can expect a response to your initial report within one business day.
While the core team works on addressing the issue, please maintain confidentiality about the vulnerability to ensure the security of all users.
Please refrain from exploiting the vulnerability or revealing the problem to others.
While we don't currently have a formal bug bounty program due to the project's nascent stage, we can assure you that:
While Twenty doesn't have a formal bug bounty program right now due to the project's nascent stage, rest assured that:
- Your report will be responded to within one business day.
- Your report and all accompanying data will be handled with utmost confidentiality.
- We greatly appreciate your contribution and would be happy to acknowledge your role in the vulnerability fix, should you choose to be identified.
- We will grant you permission to publicly discuss your findings after the patch has been released and a reasonable time has passed for users to implement it.
- We (obviously) guarantee that we will not pursue any legal action as long as the vulnerability is not exploited.
- You will get a response within one business day.
- Your report and all accompanying data will receive the highest level of confidentiality.
- Your contribution is greatly appreciated, and Twenty would acknowledge your role in the vulnerability fix, if you opt for identification.
- Twenty will grant you permission to publicly discuss your findings once users have had a reasonable time to apply the patch after it becomes available.
- Twenty guarantees not to pursue any legal action as long as the vulnerability is not exploited.
## Security Features
We are always looking for ways to improve our product's security.
If you have any recommendations or feature request that could enhance the product's security, we invite you to share them with us via the discussion forum.
Efforts are continually made to enhance the security of the product.
If you have any recommendations or feature request that could enhance the product's security, please share them via the discussion forum.
⚠️ Note this does not apply to security vulnerabilities. If you're in doubt, then always follow the security vulnerability process

View File

@ -45,6 +45,7 @@ exceptions:
- PDF
- PHP
- POST
- PII
- RAM
- REPL
- RSA
@ -58,6 +59,7 @@ exceptions:
- TBD
- TCP
- TODO
- TSX
- URI
- URL
- USB

View File

@ -1,6 +1,6 @@
extends: existence
message: "Consider using typescript instead of tsx"
level: warning
level: suggestion
scope: raw
ignorecase: true
raw:

View File

@ -83,7 +83,6 @@ tokens:
- exclusively
- expedite
- expend
- expiration
- facilitate
- factual evidence
- feasible
@ -208,7 +207,6 @@ tokens:
- took advantage of
- transmit
- transpire
- type of
- until such time as
- utilization
- utilize

View File

@ -124,7 +124,6 @@ tokens:
- normally
- obediently
- occasionally
- only
- openly
- painfully
- particularly