Skip to content

Conversation

@ryanseys
Copy link
Contributor

  • Simplify instructions
  • Follow 80 character line limits
  • Add ##Testing section
  • Move link URLs to bottom

@ryanseys ryanseys added the docs label Aug 30, 2014
@ryanseys ryanseys changed the title Clean up contributing docs: Clean up contributing Aug 30, 2014
@stephenplusplus
Copy link
Contributor

Nice!

Regarding the 80 char limit, I wouldn't mind Markdown not having to follow that rule. Our editors line wrapping paragraphs isn't as bad as line wrapping code. Then we can avoid the weird link syntax :)

CONTRIBUTING.md Outdated

This comment was marked as spam.

This comment was marked as spam.

@ryanseys
Copy link
Contributor Author

I'm indifferent. I put the links at the bottom to make the markdown more
passively readable and so we can test all links easily without perusing the
whole doc. The 80 char limit pretty much came for free so in the future we
can always go over 80.

Let me know if I should revert the 80 char changes or links.

@stephenplusplus
Copy link
Contributor

so we can test all links easily without perusing the whole doc.

Never thought of that -- I like it 👍

I think we can lift the 80 char limit and let the lines run on. However, in any code blocks (thinking readme), we should still use 80/80-ish.

@ryanseys
Copy link
Contributor Author

Updated:

  • Removed the 80 char limit and let the lines run.
  • Kept the links at the bottom (and updated a few from http://code.google.com to https://developers.google.com)
  • Changed code snippets into code blocks with sh syntax highlighting.
  • Amended last commit so this PR is still just 1 commit.

CONTRIBUTING.md Outdated

This comment was marked as spam.

@stephenplusplus
Copy link
Contributor

It looks great to me! I would merge, but I have a feeling @silvolu may want to give it a look 👓.

@ryanseys
Copy link
Contributor Author

Fixed the extra line break. @silvolu PTAL (after the holiday of course 😄)

silvolu added a commit that referenced this pull request Sep 2, 2014
@silvolu silvolu merged commit 88e0329 into googleapis:master Sep 2, 2014
@ryanseys ryanseys deleted the clean-contributing branch September 2, 2014 18:55
chingor13 pushed a commit that referenced this pull request Sep 12, 2022
Source-Link: googleapis/synthtool@d229a12
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:74ab2b3c71ef27e6d8b69b1d0a0c9d31447777b79ac3cd4be82c265b45f37e5e
chingor13 pushed a commit that referenced this pull request Sep 14, 2022
Source-Link: googleapis/synthtool@d229a12
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:74ab2b3c71ef27e6d8b69b1d0a0c9d31447777b79ac3cd4be82c265b45f37e5e
@release-please release-please bot mentioned this pull request Sep 14, 2022
sofisl pushed a commit that referenced this pull request Sep 16, 2022
sofisl pushed a commit that referenced this pull request Oct 5, 2022
sofisl pushed a commit that referenced this pull request Nov 11, 2022
* test: use fully qualified request type name in tests

PiperOrigin-RevId: 475685359

Source-Link: googleapis/googleapis@7a12973

Source-Link: googleapis/googleapis-gen@370c729
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMzcwYzcyOWUyYmEwNjJhMTY3NDQ5YzI3ODgyYmE1ZjM3OWM1YzM0ZCJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
@release-please release-please bot mentioned this pull request Nov 12, 2022
sofisl pushed a commit that referenced this pull request Nov 16, 2022
sofisl pushed a commit that referenced this pull request Nov 16, 2022
sofisl pushed a commit that referenced this pull request Nov 17, 2022
* Refactor tests.

* Tweak build.

* Tweak build.

* More tests.

* Tweak build.

* Tweak build.

* Fix build.

* Fix build.

* Speed up build.

* Fix build.

* Remove extra dep.

* Investigate why 0.12 fails.

* Scripts.

* More tests.

* Upgrades

* Upgrades

* Update readme
sofisl pushed a commit that referenced this pull request Nov 17, 2022
sofisl pushed a commit that referenced this pull request Nov 18, 2022
sofisl pushed a commit that referenced this pull request Jan 17, 2023
* Refactor tests.

* Tweak build.

* Tweak build.

* More tests.

* Tweak build.

* Tweak build.

* Fix build.

* Fix build.

* Speed up build.

* Fix build.

* Remove extra dep.

* Investigate why 0.12 fails.

* Scripts.

* More tests.

* Upgrades

* Upgrades

* Update readme
sofisl pushed a commit that referenced this pull request Jan 24, 2023
* Refactor tests.

* Tweak build.

* Tweak build.

* More tests.

* Tweak build.

* Tweak build.

* Fix build.

* Fix build.

* Speed up build.

* Fix build.

* Remove extra dep.

* Investigate why 0.12 fails.

* Scripts.

* More tests.

* Upgrades

* Upgrades

* Update readme
sofisl pushed a commit that referenced this pull request Jan 25, 2023
* Refactor tests.

* Tweak build.

* Tweak build.

* More tests.

* Tweak build.

* Tweak build.

* Fix build.

* Fix build.

* Speed up build.

* Fix build.

* Remove extra dep.

* Investigate why 0.12 fails.

* Scripts.

* More tests.

* Upgrades

* Upgrades

* Update readme
miguelvelezsa pushed a commit that referenced this pull request Jul 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants