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

README Rewrite #433

Merged
merged 15 commits into from Jun 25, 2020
Merged

README Rewrite #433

merged 15 commits into from Jun 25, 2020

Conversation

@ThunderSon
Copy link
Contributor

@ThunderSon ThunderSon commented Jun 23, 2020

  • Full README rewrite.
  • Moved Conversion rules to contributing guide
  • Basic update to the contributing guide

Another PR will be created to remove the preface (we don't need that) and update the showcased page on the website, as well as updating the contributing guide.

ThunderSon added 10 commits Jun 23, 2020
@ThunderSon ThunderSon requested review from mackowski and rbsec as code owners Jun 23, 2020
@mackowski
Copy link
Collaborator

@mackowski mackowski commented Jun 24, 2020

I will not merge it for now to let @rbsec to review.

@rbsec
Copy link
Contributor

@rbsec rbsec commented Jun 24, 2020

@ThunderSon I made some changes to what you'd done - mostly minor wording and style ones.

The contribution guide changes got a bit bigger - we had two different sections about Markdown styling which I combined.

@ThunderSon
Copy link
Contributor Author

@ThunderSon ThunderSon commented Jun 24, 2020

A small touch on the contributing guide

@ThunderSon
Copy link
Contributor Author

@ThunderSon ThunderSon commented Jun 24, 2020

Should we handle the preface in here? I feel like removing that file and just replacing it with the README on the main website.

@jmanico
Copy link
Member

@jmanico jmanico commented Jun 24, 2020

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
ThunderSon added 2 commits Jun 25, 2020
…CheatSheetSeries into chore/readme-rewrite
@ThunderSon
Copy link
Contributor Author

@ThunderSon ThunderSon commented Jun 25, 2020

After giving it a second thought, the preface needs to stay separate as the content that should be shown on the website needs to differ a bit from the README (which focuses more on GitHub). I'll give it another look later on.

@rbsec
rbsec approved these changes Jun 25, 2020
@ThunderSon ThunderSon merged commit d34bfc8 into OWASP:master Jun 25, 2020
2 of 3 checks passed
2 of 3 checks passed
link-check link-check
Details
lint
Details
Publishing Check
Details
@ThunderSon ThunderSon deleted the ThunderSon:chore/readme-rewrite branch Jun 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants