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

Update README & pr-template #78

Merged
merged 4 commits into from
Oct 7, 2024

Conversation

Robert-MacWha
Copy link
Contributor

Frameworks PR Checklist

Thank you for contributing to the Security Frameworks! Before you open a PR, make sure to read information for contributors and take a look at following checklist:

  • Describe your changes, substitute this text with the information
  • If you are touching an existing piece of content, ask the original creator for review
  • If you need feedback for your content from wider community, share the PR in our Discord
  • Review changes to ensure there are no typos, see instructions below

Changes
Updated the README for clarity & style.

The list having randomly ordered numbers bugged me. I figured it was better to make this a separate PR that include it in the Safe Harbor one, so here we are.

@mattaereal - I imagine you'd review the PR anyways, but calling on you regardless since it is your README.

Copy link

vercel bot commented Oct 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
frameworks ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 7, 2024 3:30am

@Robert-MacWha
Copy link
Contributor Author

It seems like there are existing spelling errors. Was that linter added recently? I imagine someone else has a PR to fix them. If not, I'd be happy to fix it myself - just lmk.

@Robert-MacWha
Copy link
Contributor Author

Also (and blatantly out of scope) it might be worthwhile recommending people use some kind of markdown editor (ie Obsidian, MarkText.) It seems like this repo is geared towards a lower-tech audience (based on the README instructions) and this might be more comfortable. Plus, it would provide red squiggles for spelling errors.

@Robert-MacWha Robert-MacWha changed the title docs: Update README ##pull-requests docs: Update README & pr-template Oct 7, 2024
@Robert-MacWha Robert-MacWha changed the title docs: Update README & pr-template Update README & pr-template Oct 7, 2024
@mattaereal
Copy link
Collaborator

It seems like there are existing spelling errors. Was that linter added recently? I imagine someone else has a PR to fix them. If not, I'd be happy to fix it myself - just lmk.

Yeah, Freddy added it recently, and Mehdi took on the task to fix some of them. If you'd like to contribute with that as well be my guest! :)

@mattaereal mattaereal merged commit 023a876 into security-alliance:develop Oct 7, 2024
3 of 4 checks passed
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.

2 participants