-
Notifications
You must be signed in to change notification settings - Fork 617
perlmodstyle Update module documentation section #24330
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
robrwo
wants to merge
6
commits into
Perl:blead
Choose a base branch
from
robrwo:rrwo/update-pod-style-sections
base: blead
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+94
−25
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
663f089
perlmodstyle: Update POD sections for DOCUMENTING YOUR MODULE
robrwo 22ef1af
perlmodstyle: Update section on the README, INSTALL etc
robrwo f613603
perlmodstyle: Refer users to perlpodstyle for more details
robrwo 2d5d321
perlmodstyle: Add a section on community health documents
robrwo b63fdf5
perlmodstyle: mention why README.pod should not be used
robrwo 98a5d72
Add COPYING as an alternative to LICENSE
robrwo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -542,11 +542,35 @@ DESCRIPTION | |
| =item * | ||
|
|
||
| One or more sections or subsections giving greater detail of available | ||
| methods and routines and any other relevant information. | ||
| methods and routines and any other relevant information. For example, | ||
|
|
||
| =over 4 | ||
|
|
||
| =item * | ||
|
|
||
| EXPORTS | ||
|
|
||
| =item * | ||
|
|
||
| METHODS | ||
|
|
||
| =back | ||
|
|
||
| =item * | ||
|
|
||
| SECURITY CONSIDERATIONS | ||
|
|
||
| =item * | ||
|
|
||
| BUGS/CAVEATS/etc | ||
| KNOWN ISSUES/CAVEATS/LIMITATIONS | ||
|
|
||
| =item * | ||
|
|
||
| SOURCE | ||
|
|
||
| =item * | ||
|
|
||
| SUPPORT/REPORTING ISSUES/BUGS | ||
|
|
||
| =item * | ||
|
|
||
|
|
@@ -568,48 +592,94 @@ method's subroutine. This makes it easier to keep the documentation up | |
| to date, and avoids having to document each piece of code twice (once in | ||
| POD and once in comments). | ||
|
|
||
| The sections are described in more detail in L<perlpodstyle>. | ||
|
|
||
| =head2 README, INSTALL, release notes, changelogs | ||
|
|
||
| Your module should also include a README file describing the module and | ||
| Your module should also include a F<README> file describing the module | ||
| and any requirements (including external libraries or files), and | ||
| giving pointers to further information (website, author email). | ||
|
|
||
| An INSTALL file should be included, and should contain simple installation | ||
| instructions. When using ExtUtils::MakeMaker this will usually be: | ||
| The F<README> should be a plain text file or markdown (F<README.md>) file. | ||
| Note that files like F<README.pod> should not be included in the | ||
| distribution, as they may confuse tools that interpret it as module | ||
| documentation, including the installer. | ||
|
|
||
| =over 4 | ||
| Installation instructions should be included, either as a section in F<README> | ||
| or as a separate F<INSTALL> file. It should contain simple installation | ||
| instructions. When using L<ExtUtils::MakeMaker> this will usually be: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Acknowledging that this is what was already in the documentation, this should also mention using a CPAN installer which would also handle proper installation of prerequisites. |
||
|
|
||
| =item perl Makefile.PL | ||
| perl Makefile.PL | ||
| make | ||
| make test | ||
| make install | ||
|
|
||
| =item make | ||
| When using L<Module::Build>, this will usually be: | ||
|
|
||
| =item make test | ||
| perl Build.PL | ||
| perl Build | ||
| perl Build test | ||
| perl Build install | ||
|
|
||
| =item make install | ||
| Release notes or changelogs should be produced for each release of your | ||
| software describing user-visible changes to your module, in terms | ||
| relevant to the user. | ||
|
|
||
| =back | ||
| Unless you have good reasons for using some other format | ||
| (for example, a format used within your company), | ||
| the convention is to name your changelog file C<Changes>, | ||
| and to follow the simple format described in L<CPAN::Changes::Spec>. | ||
|
|
||
| When using Module::Build, this will usually be: | ||
| =head2 Community Health Documents | ||
|
|
||
| You may want to add additional documents to your distribution. | ||
|
|
||
| =over 4 | ||
|
|
||
| =item perl Build.PL | ||
| =item F<LICENSE> or F<COPYING> | ||
|
|
||
| =item perl Build | ||
| This contains the full text of the license. | ||
|
|
||
| =item perl Build test | ||
| =item F<SECURITY.md> | ||
|
|
||
| =item perl Build install | ||
| This is a security policy that tells users how to report a security | ||
| vulnerability, and how you will handle such reports. See the CPAN | ||
| L<Guidelines for Adding a Security Policy to Perl Distributions|https://security.metacpan.org/docs/guides/security-policy-for-authors.html> for more information. | ||
|
|
||
| =back | ||
| =item F<AI_POLICY.md> | ||
|
|
||
| Release notes or changelogs should be produced for each release of your | ||
| software describing user-visible changes to your module, in terms | ||
| relevant to the user. | ||
| This outlines your policy on using AI/LLM tools for your distribution. | ||
| Is AI used to identify bugs? Is AI used to fix bugs and add new features? | ||
| Can AI tools make changes to code automatically without human interaction? | ||
|
|
||
| Unless you have good reasons for using some other format | ||
| (for example, a format used within your company), | ||
| the convention is to name your changelog file C<Changes>, | ||
| and to follow the simple format described in L<CPAN::Changes::Spec>. | ||
| =item F<CONTRIBUTING.md> | ||
|
|
||
| This describes how users can participate in development and contribute | ||
| issues or code changes. | ||
|
|
||
| =item F<CODE_OF_CONDUCT.md> | ||
|
|
||
| This document describes standards of behaviour of maintainers, conteributors and other community members of the project. | ||
| This is often used for larger projects or projects with a large community of users. | ||
|
|
||
| =item F<FUNDING.md> | ||
|
|
||
| This is used to identify sponsors of projects, and to indicate how the | ||
| project can be supported financially. | ||
|
|
||
| =item F<GOVERNANCE.md> | ||
|
|
||
| This will describe how the project is run, the different roles of | ||
| people in the project, and how decisions are made. | ||
|
|
||
| =item F<SUPPORT.md> | ||
|
|
||
| This will describe how users can get support for a project. It | ||
| indicates what aspects of the project you support (e.g. what Perl | ||
| versions and releases), and where people can find help (forums, IRC | ||
| channels, etc.) | ||
|
|
||
| =back | ||
|
|
||
| =head1 RELEASE CONSIDERATIONS | ||
|
|
||
|
|
@@ -805,4 +875,3 @@ authors. | |
| =head1 AUTHOR | ||
|
|
||
| Kirrily "Skud" Robert <skud@cpan.org> | ||
|
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.