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

Add invitation to open issues #524

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

torgo
Copy link
Contributor

@torgo torgo commented Jun 4, 2024

Add an invitation to open issues to the regexp summary doc

Add an invitation to open issues to the regexp summary doc

Signed-off-by: Daniel Appelquist <dan@torgo.com>
Copy link
Member

@ctcpip ctcpip left a comment

Choose a reason for hiding this comment

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

LGTM; also added a suggestion of possible rewording

docs/Correctly-Using-Regular-Expressions.md Outdated Show resolved Hide resolved
Co-authored-by: Chris de Almeida <ctcpip@users.noreply.github.com>
Signed-off-by: Daniel Appelquist <dan@torgo.com>
@torgo
Copy link
Contributor Author

torgo commented Jun 7, 2024

LGTM; also added a suggestion of possible rewording

Thanks for that @ctcpip. I've accepted the suggestion and also edited #523 to match,

@@ -129,4 +129,10 @@ In addition, ensure your regex is not vulnerable to a Regular Expression Denial

For detailed rationale, along with other information such as contributor credits, see [Correctly Using Regular Expressions for Secure Input Validation - Rationale](./Correctly-Using-Regular-Expressions-Rationale).

## Contributions and Corrections Welcome

If you have any additions, changes, or corrections you'd like to suggest, please [open an issue](https://github.com/ossf/wg-best-practices-os-developers/issues). We appreciate your contributions!
Copy link
Contributor

Choose a reason for hiding this comment

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

I like the basic idea! However, instead of only recommending issues, we should recommend creating issues or pull requests; we shouldn't require unnecessary steps. If there's a simple typo, I'd want them to just create a PR. E.g., something like this:

If you have any additions, changes, or corrections you'd like to suggest, please open an issue or create a pull request. We appreciate your contributions!

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

Successfully merging this pull request may close these issues.

None yet

3 participants