|
| 1 | +<!-- ========================================================================= |
| 2 | +Copyright © 2025 Network Pro Strategies (Network Pro™) |
| 3 | +SPDX-License-Identifier: CC-BY-4.0 OR GPL-3.0-or-later |
| 4 | +This file is part of Network Pro. |
| 5 | +========================================================================== --> |
| 6 | + |
| 7 | +<sup>[SPDX-License-Identifier](https://spdx.dev/learn/handling-license-info): |
| 8 | +`CC-BY-4.0 OR GPL-3.0-or-later`</sup> |
| 9 | + |
| 10 | +<section id="top"> |
| 11 | + |
| 12 | +# Contributing to Network Pro Strategies |
| 13 | + |
| 14 | +</section> |
| 15 | + |
| 16 | +♥ [Network Pro Strategies](https://netwk.pro/) and want to get involved? |
| 17 | +Thanks! We're actively looking for folks interested in helping out and there |
| 18 | +are plenty of ways you can help! |
| 19 | + |
| 20 | +Please take a moment to review this document in order to make the contribution |
| 21 | +process easy and effective for everyone involved. |
| 22 | + |
| 23 | +Following these guidelines helps to communicate that you respect the time of |
| 24 | +the developers managing and developing this open source project. In return, |
| 25 | +they should reciprocate that respect in addressing your issue or assessing |
| 26 | +patches and features. |
| 27 | + |
| 28 | +## Using the issue tracker |
| 29 | + |
| 30 | +The [issue tracker](https://github.com/netwk-pro/netwk-pro.github.io/issues) is |
| 31 | +the preferred channel for [bug reports](#bugs), [features requests](#features) |
| 32 | +and [submitting pull requests](#pull-requests), but please respect the following |
| 33 | +restrictions: |
| 34 | + |
| 35 | +- Please **do not** use the issue tracker for personal support requests (use |
| 36 | + [Stack Overflow Teams](https://stack.neteng.pro/), [Discussions](https://discuss.neteng.pro), or [Discord](https://discord.neteng.pro/)). |
| 37 | + |
| 38 | +- Please **do not** derail or troll issues. Keep the discussion on topic and |
| 39 | + respect the opinions of others. |
| 40 | + |
| 41 | +<sub>[Back to top](#top)</sub> |
| 42 | + |
| 43 | +<section id="bugs"> |
| 44 | + |
| 45 | +## Bug reports |
| 46 | + |
| 47 | +</section> |
| 48 | + |
| 49 | +A bug is a _demonstrable problem_ that is caused by the code in the repository. |
| 50 | +Good bug reports are extremely helpful - thank you! |
| 51 | + |
| 52 | +Guidelines for bug reports: |
| 53 | + |
| 54 | +1. **Use the GitHub issue search** — check if the issue has already been |
| 55 | + reported. |
| 56 | + |
| 57 | +2. **Check if the issue has been fixed** — try to reproduce it using the |
| 58 | + latest `master` or development branch in the repository. |
| 59 | + |
| 60 | +3. **Isolate the problem** — ideally create a [reduced test |
| 61 | + case](https://css-tricks.com/reduced-test-cases/) and a live example. |
| 62 | + |
| 63 | +A good bug report shouldn't leave others needing to chase you down for more |
| 64 | +information. Please try to be as detailed as possible in your report. What is |
| 65 | +your environment? What steps will reproduce the issue? What browser(s) and OS |
| 66 | +experience the problem? What would you expect to be the outcome? All these |
| 67 | +details will help people to fix any potential bugs. |
| 68 | + |
| 69 | +Example: |
| 70 | + |
| 71 | +> Short and descriptive example bug report title |
| 72 | +> |
| 73 | +> A summary of the issue and the browser/OS environment in which it occurs. If |
| 74 | +> suitable, include the steps required to reproduce the bug. |
| 75 | +> |
| 76 | +> 1. This is the first step |
| 77 | +> 2. This is the second step |
| 78 | +> 3. Further steps, etc. |
| 79 | +> |
| 80 | +> `<url>` - a link to the reduced test case |
| 81 | +> |
| 82 | +> Any other information you want to share that is relevant to the issue being |
| 83 | +> reported. This might include the lines of code that you have identified as |
| 84 | +> causing the bug, and potential solutions (and your opinions on their |
| 85 | +> merits). |
| 86 | +
|
| 87 | +<sub>[Back to top](#top)</sub> |
| 88 | + |
| 89 | +<section id="features"> |
| 90 | + |
| 91 | +## Feature requests |
| 92 | + |
| 93 | +</section> |
| 94 | + |
| 95 | +Feature requests are welcome. But take a moment to find out whether your idea |
| 96 | +fits with the scope and aims of the project. It's up to _you_ to make a strong |
| 97 | +case to convince the project's developers of the merits of this feature. Please |
| 98 | +provide as much detail and context as possible. |
| 99 | + |
| 100 | +<sub>[Back to top](#top)</sub> |
| 101 | + |
| 102 | +<section id="pull-requests"> |
| 103 | + |
| 104 | +## Pull requests |
| 105 | + |
| 106 | +</section> |
| 107 | + |
| 108 | +Good pull requests - patches, improvements, new features - are a fantastic |
| 109 | +help. They should remain focused in scope and avoid containing unrelated |
| 110 | +commits. |
| 111 | + |
| 112 | +**Please ask first** before embarking on any significant pull request (e.g. |
| 113 | +implementing features, refactoring code, porting to a different language), |
| 114 | +otherwise you risk spending a lot of time working on something that the |
| 115 | +project's developers might not want to merge into the project. |
| 116 | + |
| 117 | +Please adhere to the coding conventions used throughout a project (indentation, |
| 118 | +accurate comments, etc.) and any other requirements (such as test coverage). |
| 119 | + |
| 120 | +Adhering to the following process is the best way to get your work |
| 121 | +included in the project: |
| 122 | + |
| 123 | +1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your |
| 124 | + fork, and configure the remotes: |
| 125 | + |
| 126 | + ```bash |
| 127 | + # Clone your fork of the repo into the current directory |
| 128 | + git clone https://github.com/<your-username>/netwk-pro.github.io.git |
| 129 | + # Navigate to the newly cloned directory |
| 130 | + cd netwk-pro.github.io |
| 131 | + # Assign the original repo to a remote called "upstream" |
| 132 | + git remote add upstream https://github.com/netwk-pro/netwk-pro.github.io.git |
| 133 | + ``` |
| 134 | + |
| 135 | +2. If you cloned a while ago, get the latest changes from upstream: |
| 136 | + |
| 137 | + ```bash |
| 138 | + git checkout master |
| 139 | + git pull upstream master |
| 140 | + ``` |
| 141 | + |
| 142 | +3. Create a new topic branch (off the master project development branch) to |
| 143 | + contain your feature, change, or fix: |
| 144 | + |
| 145 | + ```bash |
| 146 | + git checkout -b <topic-branch-name> |
| 147 | + ``` |
| 148 | + |
| 149 | +4. Install locked dependencies: |
| 150 | + |
| 151 | + ```bash |
| 152 | + npm ci |
| 153 | + ``` |
| 154 | + |
| 155 | + Ensure that your `node` and `npm` versions are compatible with the `engines` |
| 156 | + specification in `package.json`. |
| 157 | + |
| 158 | +5. Lint your code locally. As reflected in the `devDependencies`, the following |
| 159 | + linting and formatting tools — or equivalent — should be used: |
| 160 | + |
| 161 | + - [Prettier](https://prettier.io/) |
| 162 | + - [ESLint](https://eslint.org/) |
| 163 | + - [markdownlint](https://github.com/DavidAnson/markdownlint) and |
| 164 | + [markdownlint2](https://github.com/DavidAnson/markdownlint-cli2) |
| 165 | + - [Stylelint](https://stylelint.io/) |
| 166 | + |
| 167 | +6. Commit your changes in logical chunks. Please adhere to these [git commit |
| 168 | + message guidelines](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) |
| 169 | + or your code is unlikely be merged into the main project. Use Git's |
| 170 | + [interactive rebase](https://help.github.com/articles/about-git-rebase/) |
| 171 | + feature to tidy up your commits before making them public. |
| 172 | + |
| 173 | +7. Locally merge (or rebase) the upstream development branch into your topic branch: |
| 174 | + |
| 175 | + ```bash |
| 176 | + git pull [--rebase] upstream master |
| 177 | + ``` |
| 178 | + |
| 179 | +8. Update any applicable test cases and run tests: |
| 180 | + |
| 181 | + ```bash |
| 182 | + npm run test |
| 183 | + ``` |
| 184 | + |
| 185 | + Tests must cover changes and pass to be accepted. |
| 186 | + |
| 187 | +9. Run build and commit changes to build: |
| 188 | + |
| 189 | + ```bash |
| 190 | + npm run build |
| 191 | + git add build/ |
| 192 | + git commit |
| 193 | + ``` |
| 194 | + |
| 195 | + <!-- markdownlint-disable MD029 --> |
| 196 | + |
| 197 | +10. Push your topic branch up to your fork: |
| 198 | + |
| 199 | +```bash |
| 200 | +git push origin <topic-branch-name> |
| 201 | +``` |
| 202 | + |
| 203 | +11. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) |
| 204 | + with a clear title and description. |
| 205 | + |
| 206 | +<!-- markdownlint-enable MD029 --> |
| 207 | + |
| 208 | + |
| 209 | + |
| 210 | +**IMPORTANT**: By submitting a patch, you agree to allow the project |
| 211 | +owners to license your work under the terms of [CC BY 4.0](https://netwk.pro/license#cc-by) and the [GNU GPL](https://netwk.pro/license#gnu-gpl). |
| 212 | + |
| 213 | +<sub>[Back to top](#top)</sub> |
| 214 | + |
| 215 | +--- |
| 216 | + |
| 217 | +<span style="font-size: 12px; font-weight: bold; text-align: center;"> |
| 218 | + |
| 219 | +[Home](https://netwk.pro) | [Terms of Use](https://netwk.pro/terms-of-use) |
| 220 | +[Privacy Policy](https://netwk.pro/privacy) | [Legal](https://netwk.pro/license) |
| 221 | + |
| 222 | +</span> |
| 223 | + |
| 224 | + |
| 225 | + |
| 226 | +<span style="font-size: 12px; text-align: center;"> |
| 227 | + |
| 228 | +Copyright © 2025 |
| 229 | +**[Network Pro Strategies](https://netwk.pro/)** (Network Pro™) |
| 230 | + |
| 231 | +Network Pro™, the shield logo, and the "Locking Down Netwspan™" slogan are [trademarks](https://netwk.pro/license#trademark) of Network Pro Strategies. |
| 232 | + |
| 233 | +Licensed under **[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)** and the **[GNU GPL](https://spdx.org/licenses/GPL-3.0-or-later.html)**, as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. |
| 234 | + |
| 235 | +</span> |
0 commit comments