|
1 |
| -# Contributing Guidelines |
| 1 | +# Contributing guidelines |
2 | 2 |
|
3 |
| -The following is a set of guidelines for contributing to this project. We really appreciate that you are considering contributing! |
| 3 | +The following is a set of guidelines for contributing to this project. We really appreciate your desire to contribute! |
4 | 4 |
|
5 |
| -#### Table Of Contents |
6 |
| - |
7 |
| -[Getting Started](#getting-started) |
8 |
| - |
9 |
| -[Contributing](#contributing) |
10 |
| - |
11 |
| -[Code Guidelines](#code-guidelines) |
12 |
| - |
13 |
| -[Code of Conduct](/CODE_OF_CONDUCT.md) |
14 |
| - |
15 |
| -## Getting Started |
16 |
| - |
17 |
| -Follow the instructions on the README's [Getting Started](/README.md#Getting-Started) section to get this project up and running. |
18 |
| - |
19 |
| -<!-- ### Project Structure (OPTIONAL) --> |
20 |
| - |
21 |
| -## Contributing |
22 |
| - |
23 |
| -### Report a Bug |
24 |
| - |
25 |
| -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).** |
26 |
| - |
27 |
| -### Suggest a Feature or Enhancement |
28 |
| - |
29 |
| -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. |
30 |
| - |
31 |
| -### Open a Pull Request (PR) |
32 |
| - |
33 |
| -- 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. |
34 |
| -- Fill in the [PR template](/.github/pull_request_template.md). |
35 |
| - |
36 |
| -**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. |
37 |
| - |
38 |
| -#### F5 Contributor License Agreement (CLA) |
| 5 | +## F5 Contributor License Agreement (CLA) |
39 | 6 |
|
40 | 7 | 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.
|
41 | 8 |
|
42 |
| -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. |
| 9 | +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 Pull or Merge Requests. |
| 10 | + |
| 11 | +## Options to get started |
43 | 12 |
|
44 |
| -## Code Guidelines |
| 13 | +<!-- Separate doc pages, CONTRIBUTING_GIT.md and CONTRIBUTING_other.md. |
| 14 | +Need: issue to include "Edit this page" links, similar to what we already do for N Unit docs, https://unit.nginx.org/ --> |
45 | 15 |
|
46 |
| -<!-- ### Go/Python/Bash/etc... Guidelines (OPTIONAL) --> |
| 16 | +At this time, we support contributions using Git. We expect this audience to also know how to build documentation using the command line. If you're in this group, start with how you can [contribute with Git](./CONTRIBUTING_GIT.md). |
| 17 | +<!-- People who contribute via CloudCannon? |
47 | 18 |
|
48 |
| -### Git Guidelines |
| 19 | +We're working on alternative contribution methods, described in CONTRIBUTING_OTHER.md |
| 20 | +--> |
49 | 21 |
|
50 |
| -- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR. |
51 |
| -- 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. |
52 |
| -- 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: |
53 |
| - - In the subject line, use the present tense ("Add feature" not "Added feature"). |
54 |
| - - In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to..."). |
55 |
| - - Limit the subject line to 72 characters or less. |
56 |
| - - Reference issues and pull requests liberally after the subject line. |
57 |
| - - 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`). |
| 22 | +Alternatively, you're welcome to highight problems with our documentation as |
| 23 | +described in our [support](./SUPPORT.md) page. |
0 commit comments