Skip to content

Commit f6ba833

Browse files
bentshermanewelsmribeirodantaspditommaso
authored andcommitted
Incorporate README content into Nextflow docs (nextflow-io#4263)
Signed-off-by: Ben Sherman <[email protected]> Signed-off-by: Paolo Di Tommaso <[email protected]> Co-authored-by: Phil Ewels <[email protected]> Co-authored-by: Marcel Ribeiro-Dantas <[email protected]> Co-authored-by: Paolo Di Tommaso <[email protected]>
1 parent 2a53188 commit f6ba833

File tree

11 files changed

+376
-580
lines changed

11 files changed

+376
-580
lines changed

.editorconfig

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[*]
2+
charset = utf-8
3+
indent_size = 4
4+
indent_style = space
5+
tab_width = 4

CONTRIBUTING.md

+20-78
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,40 @@
1-
# CONTRIBUTING TO NEXTFLOW
1+
# Contributing to Nextflow
22

3-
This guide documents the best way to make various types of contributions to Nextflow,
4-
including what is required before submitting a code change.
3+
This guide documents the various ways to contribute to Nextflow, including what is required before submitting a code change.
54

6-
Contributing to Nextflow doesn't just mean writing code. Helping new users on the mailing list,
7-
testing releases and bug fixes, and improving documentation are all essential and valuable contributions. In fact, proposing
8-
significant code changes usually first requires gaining experience and credibility within the
9-
community by helping in other ways. This is also a guide to becoming an effective contributor.
5+
Contributing to Nextflow doesn't just mean writing code. Helping new users in the community, testing releases and bug fixes, and improving documentation are all essential and valuable contributions. Helping in these ways is an excellent way to become an effective contributor and gain credibility within the community, which makes it easier to make larger contributions like code changes and new features.
106

7+
## Helping Other Users
118

12-
## Contributing by Helping Other Users
9+
A great way to contribute to Nextflow is to answer user questions on the [community forum](https://community.seqera.io) and the [Nextflow Slack](https://www.nextflow.io/slack-invite.html). Contributors should ideally be active members here and keep up with the latest developments in the Nextflow community. There are always many new Nextflow users, so taking a few minutes to help answer a question is a valuable community service and a great way to demonstrate your expertise.
1310

14-
A great way to contribute to Nextflow is to help answer user questions on the [discussion forum](https://github.com/nextflow-io/nextflow/discussions),
15-
or the [Slack channel](https://www.nextflow.io/slack-invite.html).
16-
There are always many new Nextflow users; taking a few minutes to help answer a question is a very valuable community service.
11+
## Documentation Changes
1712

18-
Contributors should ideally subscribe to these channels and follow them in order to keep up to date
19-
on what's happening in Nextflow. Answering questions is an excellent and visible way to help the
20-
community and also demonstrates your expertise.
13+
Propose changes to the [Nextflow documentation](https://nextflow.io/docs/latest/) by editing the source files in the [docs](https://github.com/nextflow-io/nextflow/tree/master/docs) directory. The `README.md` in that directory describes how to build and preview the docs locally. Finally, open a pull request with the proposed changes.
2114

15+
## Bug Reports
2216

23-
## Contributing Documentation Changes
17+
Submitting a bug report is one of the simplest and most useful ways to contribute, as it helps us to quickly identify and fix issues and thereby make Nextflow more stable.
2418

25-
To propose a change to release documentation (that is, the docs that appear under http://docs.nextflow.io),
26-
edit the documentation source files in Nextflow's [docs/](https://github.com/nextflow-io/nextflow/tree/master/docs)
27-
directory, whose README file shows how to build the documentation locally to test your changes.
19+
Report a bug using the **New issue** button on the [issues page](https://github.com/nextflow-io/nextflow/issues). A good bug report should include a minimal test case that can replicate the reported bug. Please follow the instructions in the issue template when submitting a bug report.
2820

29-
Then open a pull request with the proposed changes.
21+
## Bug Fixes
3022

23+
Contributing bug fixes is the best way to gain experience with the Nextflow codebase and credibility within the community as a project contributor.
3124

32-
## Contributing Bug Reports
25+
If you are new to the Nextflow codebase and want to get involved, check out issues marked as [`help wanted`](https://github.com/nextflow-io/nextflow/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) or [`good first issue`](https://github.com/nextflow-io/nextflow/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+). Feel free to ask for help if you get stuck while trying to implement a fix!
3326

34-
Filling a bug report is likely the simplest and most useful way to contribute to the project.
35-
It helps us to identify issues and provide patches and therefore to make Nextflow more stable
36-
and useful.
27+
## New Features
3728

38-
Report a bug using the "New issue" button in the
39-
[issues page](https://github.com/nextflow-io/nextflow/issues) of this project.
29+
Before contributing a new feature, please submit a new feature proposal on the [issues page](https://github.com/nextflow-io/nextflow/issues) and discuss it with the community.
4030

41-
A good bug report should include a minimal executable test case able to replicate the reported bug.
31+
Submitting a proposal helps identify possible overlaps with other planned features and avoid potential misunderstandings, conflicts, and wasted effort.
4232

43-
Follow the instructions in the bug [report template](https://github.com/nextflow-io/nextflow/blob/master/.github/issue_template.md) that is shown when filling the bug report out.
33+
## Code Changes
4434

45-
## Contributing Bug Fixes
35+
When submitting a contribution, you will be required to sign a [Developer Certificate of Origin (DCO)](https://developercertificate.org/) to certify that you are the author of the source code or otherwise have the right to submit it to the project.
4636

47-
Contributing bug fixes is the best way to gain experience and credibility within the community
48-
and also to become an effective project contributor.
49-
50-
If you are a novice with the Nextflow code base, start by looking at issues marked
51-
with the [help wanted](https://github.com/nextflow-io/nextflow/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
52-
label.
53-
54-
If you have doubts on how to fix an issue, ask for help from senior contributors commenting
55-
in the issue page.
56-
57-
## Contributing New Features
58-
59-
Before contributing a new feature, submit a new feature proposal in the
60-
[issues page](https://github.com/nextflow-io/nextflow/issues) of the project and discuss it
61-
with the community.
62-
63-
This is important to identify possible overlaps with other planned features and avoid misunderstandings and conflicts.
64-
65-
## Contributing Code Changes
66-
67-
When submitting a contribution, you will be required to sign a [Developer Certificate of Origin (DCO)](https://developercertificate.org/) to certify that you are the author of the source code or otherwise you have the right to submit it to the project.
68-
69-
Contributor signatures are provided by adding a `Signed-off-by` line to the commit message
70-
as shown below, or by using the `-s` option for the [git commit command](https://help.github.com/articles/signing-commits/).
37+
Contributor signatures are provided by adding a `Signed-off-by` line to the commit message as shown below, or by using the `-s` option with [`git commit`](https://help.github.com/articles/signing-commits/). For example:
7138

7239
```
7340
This is my commit message
@@ -77,29 +44,4 @@ Signed-off-by: Random J Developer <[email protected]>
7744

7845
The process is automatically managed by the [Probot](https://probot.github.io/apps/dco/) app for GitHub.
7946

80-
81-
## IDE settings
82-
83-
The suggested development environment is [IntelliJ IDEA](https://www.jetbrains.com/idea/download/). See the [README](https://github.com/nextflow-io/nextflow/#intellij-idea) for a short primer on how to import
84-
and configure Nextflow to work with it.
85-
86-
Nextflow does not impose a strict code formatting style, however the following settings should be applied:
87-
88-
* Use spaces for indentation
89-
* Tab size: 4
90-
* Indent: 4
91-
* Use single class import
92-
* Class count to use import with `*`: 99
93-
* Names count to use static import with `*`: 99
94-
* Imports layout:
95-
* \<blank line>
96-
* `import org.junit.*`
97-
* `import spock.lang.*`
98-
* \<blank line>
99-
* `import java.*`
100-
* `import javax.*`
101-
* \<blank line>
102-
* *all other imports*
103-
* *all other static imports*
104-
105-
New files must include the appropriate license header boilerplate and the author name(s) and contact email(s) ([see for example](https://github.com/nextflow-io/nextflow/blob/e8945e8b6fc355d3f2eec793d8f288515db2f409/modules/nextflow/src/main/groovy/nextflow/Const.groovy#L1-L15)).
47+
For more information about working on the Nextflow source code, visit the [Nextflow docs](https://nextflow.io/docs/latest/developer/).

0 commit comments

Comments
 (0)