Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve wording for code conventions #9558

Closed
wants to merge 2 commits into from

Conversation

leobalter
Copy link

sustainable code can replace the current wording without the use of quotes, because it's probably the real intention of that phrase.

The quotes sounds like a documentation smell. Other words can be used, but might bring the discussion (bikeshedding) if that item is really necessary in that list.

  • Write human-readable code
  • Avoid writing unreadable code
  • Write comprehensible code

Any of them are subjective. Following the other items in that list is good enough already.

@facebook-github-bot
Copy link

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla - and if you have received this in error or have any questions, please drop us a line at cla@fb.com. Thanks!

If you are contributing on behalf of someone else (eg your employer): the individual CLA is not sufficient - use https://developers.facebook.com/opensource/cla?type=company instead. Contact cla@fb.com if you have any questions.

@leobalter
Copy link
Author

CLA is signed.

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

@leobalter
Copy link
Author

friendly ping

@gaearon
Copy link
Collaborator

gaearon commented May 10, 2017

How about "Write code that is explicit"?

@leobalter
Copy link
Author

@gaearon, it works for me as it is better than the current phrase. It still hold some issues of being slightly subjective, but I would be +1 for this change if it's accepted.

@leobalter
Copy link
Author

a new commit is up

@bvaughn
Copy link
Contributor

bvaughn commented Oct 8, 2017

Thank you for filing this PR!

I'm sorry to be the bearer of bad news, but the documentation and source code for reactjs.org now lives in a different repository: reactjs/reactjs.org. (For more info on why we made this move, see issue #11075.)

Would you be willing to re-open this PR on the new repo? I promise we'll review it quickly!

@bvaughn bvaughn closed this Oct 8, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants