Forráskód Böngészése

Merge pull request #75 from logonoff/main

NO-JIRA: Update README to add warning not to fork this repo
openshift-merge-bot[bot] 1 éve
szülő
commit
addca71e2e
1 módosított fájl, 16 hozzáadás és 1 törlés
  1. 16 1
      README.md

+ 16 - 1
README.md

@@ -24,7 +24,22 @@ to build and run the example. To run OpenShift console in a container, either
 
 ## Getting started
 
-After cloning this repo, you should update the plugin metadata such as the
+> [!IMPORTANT]  
+> To use this template, **DO NOT FORK THIS REPOSITORY**! Click **Use this template**, then select
+> [**Create a new repository**](https://github.com/new?template_name=networking-console-plugin&template_owner=openshift)
+> to create a new repository.
+>
+> ![A screenshot showing where the "Use this template" button is located](https://i.imgur.com/AhaySbU.png)
+>
+> **Forking this repository** for purposes outside of contributing to this repository
+> **will cause issues**, as users cannot have more than one fork of a template repository
+> at a time. This could prevent future users from forking and contributing to your plugin.
+> 
+> Your fork would also behave like a template repository, which might be confusing for
+> contributiors, because it is not possible for repositories generated from a template
+> repository to contribute back to the template.
+
+After cloning your instantiated repository, you must update the plugin metadata, such as the
 plugin name in the `consolePlugin` declaration of [package.json](package.json).
 
 ```json