Skip to content

Commit f67de57

Browse files
committed
Some guidelines about introducing new features closes #2133
1 parent 0752731 commit f67de57

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,23 @@ in the [#perl6 IRC channel](https://perl6.org/community/irc).
4040
* Link to external resources (like Wikipedia) for topics that are not
4141
directly related to Perl 6 (like the math that our routines implement).
4242
* Duplicate small pieces of information rather than rely on linking.
43-
* Be explicit about routine signatures. If a method accepts a `*%args`,
43+
* Be explicit about routine signatures. If a method accepts an `*%args`,
4444
but treats some of them specially, list them separately.
4545
* Check out [the styleguide](writing-docs/STYLEGUIDE.md) for further guidance.
46-
* If you are participating in one of the monthly squashathons, [please read this guide](writing-docs/SQUASHATHONS.md).
46+
* If you are participating in one of the monthly
47+
squashathons,
48+
[please read this guide](writing-docs/SQUASHATHONS.md).
49+
50+
## Documenting versions
51+
52+
* If you are adding a recently introduced feature, please indicate in a note which version was it introduced in.
53+
* Try to add documentation
54+
for [Star versions](https://rakudo.org/files/star/source). Features
55+
introduced into non-star versions should probably wait.
56+
* If you change an example to use the new feature, leave the old
57+
example if it's still working, at least while it's not obsolete, for people who has not
58+
upgraded yet, clarifying in the text around it the versions it will
59+
run.
4760

4861
## Writing Code Examples
4962

@@ -90,7 +103,7 @@ Fill the documentation file `doc/Type/MyFunnyRole.pod6` like this:
90103
MyFunnyRole.do-it(2); # OUTPUT: «example output␤»
91104

92105

93-
When documenting a pair of a sub and a method which both do the same thing, the
106+
When documenting a pair of a sub and a method with the same functionality, the
94107
heading should be `=head2 routine do-it`, and the next thing should be two or
95108
more lines with the signatures. Other allowed words instead of `method` are
96109
`sub`, `trait`, `infix`, `prefix`, `postfix`, `circumfix`, `postcircumfix`,
@@ -165,7 +178,10 @@ use
165178
among which these are probably the most common:
166179

167180
* [`docs`](https://github.com/perl6/doc/labels/docs) - missing or
168-
incorrect documentation; use [`NOTSPECCED`](https://github.com/perl6/doc/labels/NOTSPECCED) instead, if this is for a feature present in a compiler, but not in the Perl 6 test suite.
181+
incorrect documentation;
182+
use [`NOTSPECCED`](https://github.com/perl6/doc/labels/NOTSPECCED)
183+
instead, if this is for a feature present in a compiler, but not in
184+
the Perl 6 test suite.
169185
* [`search`](https://github.com/perl6/doc/labels/search) - the search
170186
component, either for items that are on the site but not searchable,
171187
or for the search functionality itself.

0 commit comments

Comments
 (0)