Skip to content

Commit 2453e59

Browse files
committed
minor edits, remove fancy single quotes
1 parent e300e78 commit 2453e59

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

package-submission.Rmd

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ _Bioconductor_ packages are broadly defined by four main package types:
3838

3939
* Software Packages. Most packages contributed by users are software
4040
packages. Software packages provide implementation of algorithms
41-
(e.g. statistical analysis), access to resources (e.g. biomart, or NCBI) or
41+
(e.g. statistical analysis), access to resources (e.g. `biomaRt`, or NCBI) or
4242
visualizations (e.g. volcano plots, pathways plots). Instructions for creating
4343
Software packages can be found here: [Package guidelines][guidelines].
4444

@@ -85,7 +85,7 @@ package contributor discontinues package maintenance. See Bioconductor's package
8585
[end-of-life policy][] for more details.
8686

8787
ii) Uniqueness of package name. Packages should be named in a way that does not
88-
conflict (irrespective of case) with any current or past BIOCONDUCTOR package,
88+
conflict (irrespective of case) with any current or past Bioconductor package,
8989
nor any current or past CRAN package.
9090

9191
See [Package naming guidelines](#package-name) for more guidelines.
@@ -97,24 +97,24 @@ package maintenance responsibilities. Package authors are expected to:
9797

9898
* Follow Bioconductor guidelines
9999

100-
These include standard [guidelines][guidelines], [version numbering][versioning],
101-
[coding style](#r-code), [code performance
102-
requirements](#correctness-space-and-time), [memory usage](#memory), [using
103-
existing data classes][bioc-common], and the other requirements described
104-
below.
100+
These include standard [guidelines][guidelines],
101+
[version numbering][versioning], [coding style](#r-code),
102+
[code performance requirements](#correctness-space-and-time),
103+
[memory usage](#memory), [using existing data classes][bioc-common],
104+
and the other requirements described below.
105105

106106
* Follow the release cycle of Bioconductor
107107

108108
There are two releases each year, around April and October. The
109109
[release schedule][release-schedule] will indicate the timetables and
110110
deadlines for each release. A release cycle typically produces two
111-
versions of packages, devel and release. It is important to be familiar
111+
versions of packages, 'devel' and 'release'. It is important to be familiar
112112
with these branch concepts. Once your package has been accepted, it will
113-
initially be in the devel branch. The current devel branch becomes the
113+
initially be in the 'devel' branch. The current devel branch becomes the
114114
next release. Most users are expected to use the release branch, so they will
115115
not immediately have access to your package until the next release.
116116
Bug fixes can be fixed in both branches, while new features should only
117-
be added to the devel branch.
117+
be added to the 'devel' branch.
118118

119119
* Maintain the package using version control
120120

@@ -175,7 +175,7 @@ package maintenance responsibilities. Package authors are expected to:
175175
the issue you are opening. You cannot specify any alternative branches; the
176176
default branch is utilized. The default branch must contain only package
177177
code. Any files or directories for other applications (Github Actions,
178-
devtool, etc) should be in a different branch. If you are submitting two
178+
devtools, etc) should be in a different branch. If you are submitting two
179179
highly related packages or circular dependent packages please see
180180
[here][cirdep]. The lighter dependent or package that can be installed without
181181
a dependency should be submitted first; this is generally the associated data
@@ -370,5 +370,3 @@ package documentation and structure. Use the
370370
<[email protected]> to obtain additional support.
371371

372372
* Support Email: <[email protected]>
373-
374-

0 commit comments

Comments
 (0)