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

Improve meta documents #240

Merged
merged 7 commits into from Dec 21, 2019
Merged

Improve meta documents #240

merged 7 commits into from Dec 21, 2019

Conversation

victoriadrake
Copy link
Collaborator

This PR closes #237.

  • This PR handles the issue and requires no additional PRs.
  • You have validated the need for this change.

What did this PR accomplish?

  • Add Style Guide
  • Clarify contributing instructions
  • Introduce issue naming convention
  • Fix up README
  • Improve article example and template explanation
  • Remove underscores from issue templates since content is viewed as
    Markdown

- Add Style Guide
- Clarify contributing instructions
- Introduce issue naming convention
- Fix up README
- Improve article example and template explanation
- Remove underscores from issue templates since content is viewed as
Markdown
Style_Guide.md Outdated Show resolved Hide resolved
Comment on lines +26 to +28
- Read the current content and help us fix any spelling mistakes or grammatical errors.
- Choose an existing issue and submit a pull request to fix it.
- Open a new issue to report an opportunity for improvement.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are deliberately no links to choosing or opening issues here in order to funnel readers to CONTRIBUTING.md, linked below.

@kingthorin
Copy link
Collaborator

kingthorin commented Dec 15, 2019

I'll try to review this in the next few days. Did you mean to include the template changes?

Thank you for including a section on "and/or", that's a pet peeve of mine.

For the "ie/eg" part should we include something about "ex"? What about "etc" or well "etc." (with a single period not an ellipsis...which essentially works out to be etc etc and redundant.) [All four of those recently came up with the Zap project.]

Style_Guide.md Outdated Show resolved Hide resolved
@victoriadrake
Copy link
Collaborator Author

victoriadrake commented Dec 16, 2019

I'll try to review this in the next few days. Did you mean to include the template changes?

Yes.

Thank you for including a section on "and/or", that's a pet peeve of mine.

Thought of you!

For the "ie/eg" part should we include something about "ex"? What about "etc" or well "etc." (with a single period not an ellipsis...which essentially works out to be etc etc and redundant.) [All four of those recently came up with the Zap project.]

That's great, I'll add those.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Style_Guide.md Outdated Show resolved Hide resolved
Style_Guide.md Outdated Show resolved Hide resolved
kingthorin
kingthorin previously approved these changes Dec 20, 2019
Copy link
Collaborator

@kingthorin kingthorin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

Copy link
Collaborator

@ThunderSon ThunderSon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor changes. You've done a wonderful job!

.github/ISSUE_TEMPLATE/feature_request.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
style_guide.md Outdated Show resolved Hide resolved
style_guide.md Show resolved Hide resolved
@ThunderSon ThunderSon merged commit 8791969 into OWASP:master Dec 21, 2019
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.

Improve contribution guidance
4 participants