You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update broken CoC link and minor grammar changes (#3749)
# Description
I noticed the Code of Conduct link was broken, so I updated it. While
reading through the file, I made some minor grammatical updates for
consistency and accuracy.
# Changed Behaviour
N/A
# Fixes
N/A
## Type of change
Choose which options apply, and delete the ones which do not apply.
- Update to human readable text: Documentation/error messages/comments
Copy file name to clipboardExpand all lines: CONTRIBUTING.rst
+27-27Lines changed: 27 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
-
Where to start
1
+
Where to Start
2
2
--------------
3
3
4
-
We eagerly welcome contributions of any type (e.g., bug fixes, new features, reporting issues, documentation, etc). If you're looking for a good place to get started you might like to peruse our current Git issues (those marked with `help wanted <https://github.com/Parsl/parsl/labels/help%20wanted>`_ are a good place to start).
4
+
We eagerly welcome contributions of any type (e.g., bug fixes, new features, reporting issues, documentation, etc). If you're looking for a good place to start, we recommend perusing our current Git issues (those marked with `help wanted <https://github.com/Parsl/parsl/labels/help%20wanted>`_ are a good place to start).
5
5
6
-
Please be aware of `Parsl's Code of Conduct <https://github.com/Parsl/parsl/blob/master/CODE_OF_CONDUCT.md>`_.
6
+
Please be aware of `Parsl's Code of Conduct <https://github.com/Parsl/.github/blob/main/CODE_OF_CONDUCT.md>`_.
7
7
8
-
If you are not familiar with GitHub pull requests, the main mechanism to contribute changes to our code, there is `documentation available <https://opensource.com/article/19/7/create-pull-request-github>`_.
8
+
If you are unfamiliar with GitHub pull requests, the primary mechanism for contributing changes to our code, there is `documentation available <https://opensource.com/article/19/7/create-pull-request-github>`_.
9
9
10
10
The best places to ask questions or discuss development activities are:
11
11
@@ -14,25 +14,25 @@ The best places to ask questions or discuss development activities are:
14
14
* using `GitHub issues <https://github.com/Parsl/parsl/issues>`_.
15
15
16
16
17
-
Coding conventions
17
+
Coding Conventions
18
18
------------------
19
19
20
-
Formatting conventions
20
+
Formatting Conventions
21
21
======================
22
22
23
23
Parsl code should adhere to Python `PEP-8 <https://peps.python.org/pep-0008/>`_. This is enforced in CI (with some exceptions). You can also run this test yourself using ``make flake8``.
24
24
25
-
Naming conventions
25
+
Naming Conventions
26
26
==================
27
27
28
-
The following convention should be followed: ClassName, ExceptionName, GLOBAL_CONSTANT_NAME, and lowercase_with_underscores for everything else.
28
+
The following conventions should be followed: ClassName, ExceptionName, GLOBAL_CONSTANT_NAME, and lowercase_with_underscores for everything else.
29
29
30
-
Version increments
30
+
Version Increments
31
31
==================
32
32
33
33
Parsl follows the `calendar versioning scheme <https://calver.org/#scheme>`_ with ``YYYY.MM.DD`` numbering scheme for versions.
34
-
This scheme was chosen following a switch from ad-hoc versioning and manual release processes to an automated weekly process.
35
-
Releases are pushed from github actions to PyPI and will be picked up automatically by Conda.
34
+
This scheme was chosen after switching from ad-hoc versioning and manual release processes to an automated weekly process.
35
+
Releases are pushed from GitHub actions to PyPI and will be picked up automatically by Conda.
@@ -50,14 +50,14 @@ Parsl uses ``pytest`` to run most tests. All tests should be placed in
50
50
the ``parsl/tests`` directory.
51
51
52
52
There are two broad groups of tests: those which must run with a
53
-
specific configuration, and those which should work with any
53
+
specific configuration, and those that should work with any
54
54
configuration.
55
55
56
-
Tests which should run with with any configuration live under
56
+
Tests that should run with any configuration live under
57
57
themed directories ``parsl/tests/test*/`` and should be named ``test*.py``.
58
-
They can be run with any configuration, by specifying ``--config CONFIGPATH``
58
+
They can be run with any configuration by specifying ``--config CONFIGPATH``
59
59
where CONFIGPATH is a path to a ``.py`` file exporting a parsl configuration
60
-
object named ``config``. The parsl-specific test fixtures will ensure
60
+
object named ``config``. The Parsl-specific test fixtures will ensure
61
61
a suitable DFK is loaded with that configuration for each test.
62
62
63
63
Tests which require their own specially configured DFK, or no DFK at all,
@@ -72,8 +72,8 @@ There is more fine-grained enabling and disabling of tests within the
72
72
above categories:
73
73
74
74
A pytest marker of ``cleannet`` (for clean network) can be used to select
75
-
or deselect tests which need a very clean network (for example, for tests
76
-
making FTP transfers). When the test environment (github actions) does not
75
+
or deselect tests that need a very clean network (for example, for tests
76
+
making FTP transfers). When the test environment (GitHub actions) does not
77
77
provide a sufficiently clean network, run all tests with ``-k "not cleannet"`` to
78
78
disable those tests.
79
79
@@ -92,11 +92,11 @@ specified directly in the annotation - generally because they are broken
92
92
in one way or another.
93
93
94
94
95
-
Coverage testing
95
+
Coverage Testing
96
96
================
97
97
98
98
There is also some coverage testing available. The CI by default records
99
-
coverage for most of the tests that it runs and outputs a brief report
99
+
coverage for most of the tests it runs and outputs a brief report
100
100
at the end of each CI run. This is purely informational and a Lack of
101
101
coverage won't produce a CI failure.
102
102
@@ -119,10 +119,10 @@ Parsl development follows a common pull request-based workflow similar to `GitHu
119
119
* all development occurs in branches (named with a short descriptive name, for example, `add-globus-transfer-#1`)
120
120
* the master branch is always stable
121
121
* development branches should include tests for added features
122
-
* development branches should be tested after being brought up-to-date with the master (in this way, what is being tested is what is actually going into the code; otherwise unexpected issues from merging may come up)
123
-
* branches what have been successfully tested are merged via pull requests (PRs)
122
+
* development branches should be tested after being brought up-to-date with the master (in this way, what is being tested is what is actually going into the code; otherwise, unexpected issues from merging may come up)
123
+
* branches that have been successfully tested are merged via pull requests (PRs)
124
124
* PRs should be used for review and discussion
125
-
* PRs should be reviewed in a timely manner, to reduce effort keeping them synced with other changes happening on the master branch
125
+
* PRs should be reviewed in a timely manner to reduce effort in keeping them synced with other changes happening on the master branch
126
126
127
127
Git commit messages should include a single summary sentence followed by a more explanatory paragraph. Note: all commit messages should reference the GitHub issue to which they relate. A nice discussion on the topic can be found `here <https://chris.beams.io/posts/git-commit/>`_.
128
128
::
@@ -131,25 +131,25 @@ Git commit messages should include a single summary sentence followed by a more
131
131
Added the ability to reference and automatically transfer Globus-accessible
132
132
files. References are represented using the Parsl file format
133
133
“globus://endpoint/path/file.” If Globus endpoints are known for source and
134
-
destination Parsl will use the Globus transfer service to move data to the
134
+
destination, Parsl will use the Globus transfer service to move data to the
135
135
compute host. Fixes #-1.
136
136
137
-
Git hooks
137
+
Git Hooks
138
138
---------
139
139
140
-
Developers may find it useful to setup a pre-commit git hook to automatically lint and run tests. This is a script which is run before each commit. For example::
140
+
Developers may find it useful to set up a pre-commit git hook to automatically lint and run tests. This is a script that is run before each commit. For example::
141
141
142
142
$ cat ~/parsl/.git/hooks/pre-commit
143
143
#!/bin/sh
144
144
145
145
make lint flake8 mypy local_thread_test
146
146
147
-
Project documentation
147
+
Project Documentation
148
148
---------------------
149
149
150
150
All project documentation is written in reStructuredText. `Sphinx <http://sphinx-doc.org/>`_ is used to generate the HTML documentation from the rst documentation and structured docstrings in Parsl code. Project documentation is built automatically and added to the `Parsl documentation <https://parsl.readthedocs.io>`_.
151
151
152
152
Credit and Contributions
153
153
------------------------
154
154
155
-
Parsl wants to make sure that all contributors get credit for their contributions. When you make your first contribution, it should include updating the codemeta.json file to include yourself as a contributor to the project.
155
+
Parsl wants to ensure that all contributors receive credit for their contributions. When you make your first contribution, you should update the codemeta.json file to include yourself as a contributor to the project.
0 commit comments