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

hotfix(api): quick code spell checker #548

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ericbolikowski
Copy link
Contributor

What Github issue does this PR relate to? Insert link.

What should the reviewer know?

This a "fork" from #481 to zoom in on specifically code spell checking.

Useful comment from @Paul7Peterson:

I use spell checkers to avoid a big amount of issues that are coming from that. In the PR can be seen in some places how I was fixing many typing errors that I found because of this. The configuration of glossaries can be done per user or per workspace, but makes no sense to be done for the first.

The words in the glossary (that must be in the .vscode/settings.json file) are not for describing terms in the project, but for including terms that are not recognized per the English and language-specific database of the extension. So the first bullet makes no sense for this specific case, but can be done in a separated .md file without any problem. And the second bullet it's because it's the config of an extension and must go in this specific file. I would also recommend setting a .vscode/extensions.json with the recommendation.

About the documentation of the extension, you can name the recommended extension and set a link to the source documentation, but the use of this extensión is exactly the same as the auto-corrector in word.

@ericbolikowski ericbolikowski changed the title hotfix(api): quick email template fix hotfix(api): quick code spell checker Mar 18, 2022
@gitguardian
Copy link

gitguardian bot commented Apr 27, 2023

⚠️ GitGuardian has uncovered 4 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
GitGuardian id Secret Commit Filename
753993 Generic High Entropy Secret b3e7f20 nx.json View secret
753993 Generic High Entropy Secret ad5445b nx.json View secret
753993 Generic High Entropy Secret 863d333 nx.json View secret
753993 Generic High Entropy Secret e7ef109 nx.json View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secrets safely. Learn here the best practices.
  3. Revoke and rotate these secrets.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!

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

Successfully merging this pull request may close these issues.

None yet

1 participant