Skip to content

Commit addca71

Browse files
Merge pull request #75 from logonoff/main
NO-JIRA: Update README to add warning not to fork this repo
2 parents 659b035 + 12926e9 commit addca71

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,22 @@ to build and run the example. To run OpenShift console in a container, either
2424

2525
## Getting started
2626

27-
After cloning this repo, you should update the plugin metadata such as the
27+
> [!IMPORTANT]
28+
> To use this template, **DO NOT FORK THIS REPOSITORY**! Click **Use this template**, then select
29+
> [**Create a new repository**](https://github.com/new?template_name=networking-console-plugin&template_owner=openshift)
30+
> to create a new repository.
31+
>
32+
> ![A screenshot showing where the "Use this template" button is located](https://i.imgur.com/AhaySbU.png)
33+
>
34+
> **Forking this repository** for purposes outside of contributing to this repository
35+
> **will cause issues**, as users cannot have more than one fork of a template repository
36+
> at a time. This could prevent future users from forking and contributing to your plugin.
37+
>
38+
> Your fork would also behave like a template repository, which might be confusing for
39+
> contributiors, because it is not possible for repositories generated from a template
40+
> repository to contribute back to the template.
41+
42+
After cloning your instantiated repository, you must update the plugin metadata, such as the
2843
plugin name in the `consolePlugin` declaration of [package.json](package.json).
2944

3045
```json

0 commit comments

Comments
 (0)