Contrib folder explanation #414
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
darkdrgn2k
reviewed
May 21, 2019
README.md
Outdated
| @@ -44,6 +44,8 @@ The software also supports Debian running on x86 and x64 boards, and many board | |||
|
|
|||
| During the installation, you may be able to pick a profile, or choose between many modules. To learn what each module is for, look at [MODULES.md](./docs/MODULES.md). This is important for the installation. | |||
|
|
|||
| There are some more experimental, 3rd party, or not fully supported modules in the [contrib](./contrib) folder for you to explore. Run those scripts with caution. | |||
There was a problem hiding this comment.
Contrib folders are not normally defined as they are a standard in many projects
What is the contrib folder:
It is for software that has been contributed to the project, but which might not actually be maintained by the core developers. Naming it "contrib" or "Contrib" is a long established convention.
In our case many of the scripts augment existing modules for specific task, and may need guidance to use. At present they are not documents at all.
There was a problem hiding this comment.
I will change my definition to the one you quoted.
darkdrgn2k
approved these changes
Jun 22, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #410