Skip to content

Commit 6146e71

Browse files
authored
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
1 parent 83a2030 commit 6146e71

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

CONTRIBUTING.rst

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
Where to start
1+
Where to Start
22
--------------
33

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).
55

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>`_.
77

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>`_.
99

1010
The best places to ask questions or discuss development activities are:
1111

@@ -14,25 +14,25 @@ The best places to ask questions or discuss development activities are:
1414
* using `GitHub issues <https://github.com/Parsl/parsl/issues>`_.
1515

1616

17-
Coding conventions
17+
Coding Conventions
1818
------------------
1919

20-
Formatting conventions
20+
Formatting Conventions
2121
======================
2222

2323
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``.
2424

25-
Naming conventions
25+
Naming Conventions
2626
==================
2727

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.
2929

30-
Version increments
30+
Version Increments
3131
==================
3232

3333
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.
3636
Manual packaging instructions are included in the
3737
`packaging docs <http://parsl.readthedocs.io/en/latest/devguide/packaging.html>`_
3838

@@ -50,14 +50,14 @@ Parsl uses ``pytest`` to run most tests. All tests should be placed in
5050
the ``parsl/tests`` directory.
5151

5252
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
5454
configuration.
5555

56-
Tests which should run with with any configuration live under
56+
Tests that should run with any configuration live under
5757
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``
5959
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
6161
a suitable DFK is loaded with that configuration for each test.
6262

6363
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
7272
above categories:
7373

7474
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
7777
provide a sufficiently clean network, run all tests with ``-k "not cleannet"`` to
7878
disable those tests.
7979

@@ -92,11 +92,11 @@ specified directly in the annotation - generally because they are broken
9292
in one way or another.
9393

9494

95-
Coverage testing
95+
Coverage Testing
9696
================
9797

9898
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
100100
at the end of each CI run. This is purely informational and a Lack of
101101
coverage won't produce a CI failure.
102102

@@ -119,10 +119,10 @@ Parsl development follows a common pull request-based workflow similar to `GitHu
119119
* all development occurs in branches (named with a short descriptive name, for example, `add-globus-transfer-#1`)
120120
* the master branch is always stable
121121
* 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)
124124
* 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
126126

127127
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/>`_.
128128
::
@@ -131,25 +131,25 @@ Git commit messages should include a single summary sentence followed by a more
131131
Added the ability to reference and automatically transfer Globus-accessible
132132
files. References are represented using the Parsl file format
133133
“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
135135
compute host. Fixes #-1.
136136

137-
Git hooks
137+
Git Hooks
138138
---------
139139

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::
141141

142142
$ cat ~/parsl/.git/hooks/pre-commit
143143
#!/bin/sh
144144

145145
make lint flake8 mypy local_thread_test
146146

147-
Project documentation
147+
Project Documentation
148148
---------------------
149149

150150
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>`_.
151151

152152
Credit and Contributions
153153
------------------------
154154

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

Comments
 (0)