add clarity to the language #499

moneyball · 2020-02-13T03:37:23Z

No description provided.

arik-so · 2020-02-13T08:04:12Z

CONTRIBUTING.md

 for the first time to an open source project or pick up Rust while contributing. Don't be shy,
 you'll learn.

 Communications Channels
 -----------------------

-Communication about Rust-Lightning happens primarily on #ldk-dev on the LDK slack
+Communication about Rust-Lightning happens primarily on #ldk-dev on the [LDK slack](http://www.lightningdevkit.org/)


if it's primarily on Slack, there should at least be a comma before the IRC channel, or, better yet, a connection like, "but also"

arik-so · 2020-02-13T08:04:45Z

CONTRIBUTING.md

 or #rust-bitcoin on IRC Freenode.

 Discussion about code base improvements happens in GitHub issues and on pull
 requests.

 Contribution Workflow
--------------------
+---------------------


Interesting heading mechanism. Why not just use subheadings like ##?

Not sure I didn't create that but it isn't related to my PR to improve clarity of the language so would suggest a separate Issue/PR for this.

arik-so · 2020-02-13T08:05:33Z

CONTRIBUTING.md

@@ -46,12 +45,12 @@ must be given to the long term technical debt. Every new features should
 be covered by functional tests.

 When refactoring, structure your PR to make it easy to review and don't
-hesitant to split in multiple small, focused PRs.
+hestitate to split in multiple small, focused PRs.


better: "hesitate to split it into multiple"

arik-so · 2020-02-13T08:06:47Z

CONTRIBUTING.md


 The Minimal Supported Rust Version is 1.22.0 (enforced by our Travis).

-Commit should expose both issues fixed and solutions rational.
-these [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind.
+Commit should cover both issues fixed and solutions rationale.


Probably plural, commits.

Also, solutions is possessive, so either solution's or solutions' (probably the latter if there are multiple solutions, each mapping to an issue fixed.)

arik-so · 2020-02-13T08:07:15Z

CONTRIBUTING.md


 Use tabs. If you want to align lines, use spaces. Any desired alignment should
 display fine at any tab-length display setting.

 Security
 --------

-Security is the primary focus of Rust-Lightning, disclosure of security vulnerabilites
-helps prevent user loss of funds. If you believe vulnerability may effect other Lightning
+Security is the primary focus of Rust-Lightning; disclosure of security vulnerabilites


arik-so · 2020-02-13T08:07:45Z

CONTRIBUTING.md

-Security is the primary focus of Rust-Lightning, disclosure of security vulnerabilites
-helps prevent user loss of funds. If you believe vulnerability may effect other Lightning
+Security is the primary focus of Rust-Lightning; disclosure of security vulnerabilites
+helps prevent user loss of funds. If you believe a vulnerability may affect other Lightning
 implementations please inform them.


add comma: implementations, please inform them.

arik-so · 2020-02-13T08:08:11Z

CONTRIBUTING.md

@@ -81,20 +80,20 @@ is no special handling of security issues. Please simpy open an issue on Github.
 Testing
 -------

-Deeply tied with the security aspect, Rust-Lightning developers take testing
+Related to the security aspect, Rust-Lightning developers take testing
 very seriously. Due to the modular nature of the project writing new functional


add comma: of the project, writing new

arik-so · 2020-02-13T08:08:51Z

CONTRIBUTING.md


-Fuzzing is heavily-encouraged, you will find all related fuzzing stuff under `fuzz/`
+Fuzzing is heavily encouraged: you will find all related fuzzing stuff under `fuzz/`


try replacing "stuff". Also, maybe "fuzzing-related?"

arik-so · 2020-02-13T08:09:09Z

CONTRIBUTING.md


-Mutation testing is work-in-progess, any contribution there would be warmly welcomed.
+Mutation testing is work-in-progess; any contribution there would be warmly welcomed.


typo: progress

rloomba · 2020-02-15T18:57:50Z

CONTRIBUTING.md

@@ -6,23 +6,23 @@ welcome to contribute towards development in the form of peer review, documentat
 testing and patches.

 Anyone is invited to contribute without regard to technical experience, "expertise", OSS
-experience, age, or other concern. Though developing cryptocurrencies demand a
+experience, age, or other concern. However, developing cryptocurrencies demand a


grammar ultra nit: I think demand should be demands as the subject is the gerund developing.

This could also be rewritten as: However, the development of cryptocurrencies demands...

thank you and fixed!

TheBlueMatt

LGTM. Any further comments can totally be merged as trivial PRs.

add clarity to the language

2314b0a

arik-so requested changes Feb 13, 2020

View reviewed changes

fixes per arik feedback

067dd3b

rloomba reviewed Feb 15, 2020

View reviewed changes

fixes per rloomba feedback

40e722d

TheBlueMatt approved these changes Feb 17, 2020

View reviewed changes

TheBlueMatt merged commit 4f59b8e into lightningdevkit:master Feb 17, 2020


		Fuzzing is heavily-encouraged, you will find all related fuzzing stuff under `fuzz/`
		Fuzzing is heavily encouraged: you will find all related fuzzing stuff under `fuzz/`


		Mutation testing is work-in-progess, any contribution there would be warmly welcomed.
		Mutation testing is work-in-progess; any contribution there would be warmly welcomed.

add clarity to the language #499

add clarity to the language #499

Uh oh!

Conversation

moneyball commented Feb 13, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TheBlueMatt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!