Skip to content

Commit 72b05e0

Browse files
committed
chore: revert breaking lines at 90 chars in markdown files
1 parent b1bec24 commit 72b05e0

File tree

2 files changed

+23
-48
lines changed

2 files changed

+23
-48
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Contributing Guidelines
22

3-
The following is a set of guidelines for contributing to this project. We really appreciate that you are considering
4-
contributing!
3+
The following is a set of guidelines for contributing to this project. We really appreciate that you are considering contributing!
54

65
#### Table Of Contents
76

@@ -15,57 +14,42 @@ contributing!
1514

1615
## Getting Started
1716

18-
Refer to the [Getting Started Guide](docs/getting_started.md) for how to build
19-
and run the gateway.
17+
Refer to the [Getting Started Guide](docs/getting_started.md) for how to build and run the gateway.
2018

2119
## Contributing
2220

2321
### Report a Bug
2422

25-
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please
26-
ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using
27-
our [security policy](/SECURITY.md).**
23+
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using our [security policy](/SECURITY.md).**
2824

2925
### Suggest a Feature or Enhancement
3026

31-
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the
32-
available [feature request template](/.github/feature_request_template.md). Please ensure the feature or enhancement has
33-
not already been suggested.
27+
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the available [feature request template](/.github/feature_request_template.md). Please ensure the feature or enhancement has not already been suggested.
3428

3529
### Open a Pull Request (PR)
3630

37-
- Fork the repo, create a branch, implement your changes, add any relevant tests, and submit a PR when your changes are
38-
**tested** and ready for review.
31+
- Fork the repo, create a branch, implement your changes, add any relevant tests, and submit a PR when your changes are **tested** and ready for review.
3932
- Fill in the [PR template](/.github/pull_request_template.md).
4033

41-
**Note:** If you'd like to implement a new feature, please consider creating
42-
a [feature request issue](/.github/feature_request_template.md) first to start a discussion about the feature.
34+
**Note:** If you'd like to implement a new feature, please consider creating a [feature request issue](/.github/feature_request_template.md) first to start a discussion about the feature.
4335

4436
#### F5 Contributor License Agreement (CLA)
4537

46-
F5 requires all external contributors to agree to the terms of the F5 CLA (
47-
available [here](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)) before any of their changes can be
48-
incorporated into an F5 Open Source repository.
38+
F5 requires all external contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)) before any of their changes can be incorporated into an F5 Open Source repository.
4939

50-
If you have not yet agreed to the F5 CLA terms and submit a PR to this repository, a bot will prompt you to view and
51-
agree to the F5 CLA. You will have to agree to the F5 CLA terms through a comment in the PR before any of your changes
52-
can be merged. Your agreement signature will be safely stored by F5 and no longer be required in future PRs.
40+
If you have not yet agreed to the F5 CLA terms and submit a PR to this repository, a bot will prompt you to view and agree to the F5 CLA. You will have to agree to the F5 CLA terms through a comment in the PR before any of your changes can be merged. Your agreement signature will be safely stored by F5 and no longer be required in future PRs.
5341

5442
## Code Guidelines
5543

5644
<!-- ### Go/Python/Bash/etc... Guidelines (OPTIONAL) -->
5745

5846
### Git Guidelines
5947

60-
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing
61-
before submitting a PR.
62-
- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format
63-
when writing a commit message, so that changelogs can be automatically generated.
64-
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/>
65-
and summarized in the next few points:
66-
- In the subject line, use the present tense ("Add feature" not "Added feature").
67-
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
68-
- Limit the subject line to 72 characters or less.
69-
- Reference issues and pull requests liberally after the subject line.
70-
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in
71-
your text editor to write a good message instead of `git commit -am`).
48+
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
49+
- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format when writing a commit message, so that changelogs can be automatically generated.
50+
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarized in the next few points:
51+
- In the subject line, use the present tense ("Add feature" not "Added feature").
52+
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
53+
- Limit the subject line to 72 characters or less.
54+
- Reference issues and pull requests liberally after the subject line.
55+
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).

SUPPORT.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,30 @@
44

55
We use GitHub for tracking bugs and feature requests related to this project.
66

7-
Don't know how something in this project works? Curious if this project can achieve your desired functionality? Please
8-
open an issue on GitHub with the label `question`. Alternatively, start a GitHub discussion!
7+
Don't know how something in this project works? Curious if this project can achieve your desired functionality? Please open an issue on GitHub with the label `question`. Alternatively, start a GitHub discussion!
98

109
## NGINX Specific Questions and/or Issues
1110

12-
This isn't the right place to get support for NGINX specific questions, but the following resources are available below.
13-
Thanks for your understanding!
11+
This isn't the right place to get support for NGINX specific questions, but the following resources are available below. Thanks for your understanding!
1412

1513
### Community Forum
1614

17-
We have a community [forum](https://community.nginx.org/)! If you have any questions and/or issues, try checking out
18-
the [`Troubleshooting`](https://community.nginx.org/c/troubleshooting/8) and [
19-
`How do I...?`](https://community.nginx.org/c/how-do-i/9) categories. Both fellow community members and NGINXers might
20-
be able to help you! :)
15+
We have a community [forum](https://community.nginx.org/)! If you have any questions and/or issues, try checking out the [`Troubleshooting`](https://community.nginx.org/c/troubleshooting/8) and [`How do I...?`](https://community.nginx.org/c/how-do-i/9) categories. Both fellow community members and NGINXers might be able to help you! :)
2116

2217
### Documentation
2318

2419
For a comprehensive list of all NGINX directives, check out <https://nginx.org>.
2520

26-
For a comprehensive list of administration and deployment guides for all NGINX products, check
27-
out <https://docs.nginx.com>.
21+
For a comprehensive list of administration and deployment guides for all NGINX products, check out <https://docs.nginx.com>.
2822

2923
### Mailing List
3024

31-
Want to get in touch with the NGINX development team directly? Try using the relevant mailing list found
32-
at <https://mailman.nginx.org/mailman3/lists/>!
25+
Want to get in touch with the NGINX development team directly? Try using the relevant mailing list found at <https://mailman.nginx.org/mailman3/lists/>!
3326

3427
## Contributing
3528

36-
Please see the [contributing guide](/CONTRIBUTING.md) or the [Getting Started](/README.md#getting-started) guide, for
37-
guidelines on how to best contribute to this project.
29+
Please see the [contributing guide](/CONTRIBUTING.md) or the [Getting Started](/README.md#getting-started) guide, for guidelines on how to best contribute to this project.
3830

3931
## Community Support
4032

41-
This project does **not** offer commercial support. Community support is offered on a best effort basis through either
42-
GitHub issues/PRs/discussions or through any of our active communities.
33+
This project does **not** offer commercial support. Community support is offered on a best effort basis through either GitHub issues/PRs/discussions or through any of our active communities.

0 commit comments

Comments
 (0)