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.

Sign up for GitHub

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

Jump to bottom

docs: Clean up contributing #159

Merged
merged 1 commit into from
Sep 2, 2014
Merged

docs: Clean up contributing #159

merged 1 commit into from
Sep 2, 2014

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

stephenplusplus
stephenplusplus reviewed Aug 30, 2014
View reviewed changes
CONTRIBUTING.md

Fork the repo, develop and test your code changes.
## Testing

* `npm test` to run tests.
* `npm run regression-test` to run regression tests.
* `npm run cover` to see the test coverage report.

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

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

stephenplusplus
stephenplusplus reviewed Aug 30, 2014
View reviewed changes
CONTRIBUTING.md
```

To run the regression tests, first create and configure a project following the
[instructions on how to run gcloud-node][elsewhere].

This comment was marked as spam.

Sign in to view

@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
Merge pull request #159 from ryanseys/clean-contributing
88e0329 
docs: Clean up contributing
@silvolu silvolu merged commit 88e0329 into googleapis:master Sep 2, 2014
@ryanseys ryanseys deleted the clean-contributing branch September 2, 2014 18:55
@snyk-bot snyk-bot mentioned this pull request May 21, 2020
Open
This was referenced Jul 21, 2021
Open
Open
Open
Open
Open
Open
chingor13 pushed a commit that referenced this pull request Aug 22, 2022
@yoshi-automation @JustinBeckwith
docs: update return type in jsdoc for Buffers (#159)
1377e4b
chingor13 pushed a commit that referenced this pull request Sep 12, 2022
@gcf-owl-bot
fix: change import long to require (#159)
e3979e5 
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
@gcf-owl-bot
fix: change import long to require (#159)
90cef18 
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
Merged
@sofisl sofisl mentioned this pull request Sep 16, 2022
Closed
4 tasks
sofisl pushed a commit that referenced this pull request Sep 16, 2022
@jkwlui
Release v0.3.2 (#159)
7226c6d
sofisl pushed a commit that referenced this pull request Oct 5, 2022
@jkwlui
Release v0.3.2 (#159)
fa6c0fe
This was referenced Oct 5, 2022
Closed
Closed
sofisl pushed a commit that referenced this pull request Nov 11, 2022
@renovate-bot
chore(deps): update dependency @types/node to v18 (#159)
8c7a995 
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@types/node](https://togithub.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node) ([source](https://togithub.com/DefinitelyTyped/DefinitelyTyped)) | [`^16.0.0` -> `^18.0.0`](https://renovatebot.com/diffs/npm/@types%2fnode/16.18.3/18.11.9) | [![age](https://badges.renovateapi.com/packages/npm/@types%2fnode/18.11.9/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@types%2fnode/18.11.9/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@types%2fnode/18.11.9/compatibility-slim/16.18.3)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@types%2fnode/18.11.9/confidence-slim/16.18.3)](https://docs.renovatebot.com/merge-confidence/) |

---

### Configuration

📅 **Schedule**: Branch creation - "after 9am and before 3pm" (UTC), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-dataproc-metastore).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4yNDEuMTEiLCJ1cGRhdGVkSW5WZXIiOiIzNC4xMS4xIn0=-->
This was referenced Nov 11, 2022
Merged
Merged
sofisl pushed a commit that referenced this pull request Nov 11, 2022
@gcf-owl-bot
build(node): update deps used during postprocessing (#1243) (#159)
b755906
@sofisl sofisl mentioned this pull request Nov 11, 2022
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Nov 11, 2022
@yoshi-automation @JustinBeckwith
fix: DEADLINE_EXCEEDED retry code is idempotent (#159)
47a2ee9
@sofisl sofisl mentioned this pull request Nov 11, 2022
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Nov 11, 2022
@gcf-owl-bot
test: use fully qualified request type name in tests (#159)
6c28415 
* 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
Merged
@sofisl sofisl mentioned this pull request Nov 16, 2022
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Nov 16, 2022
@alexander-fenster
fix(deps): use google-gax v3.5.2 (#159)
26f159d
sofisl pushed a commit that referenced this pull request Nov 16, 2022
@JustinBeckwith
chore: remove tslint.json (#159)
18ed637
@sofisl sofisl mentioned this pull request Nov 16, 2022
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Nov 17, 2022
@jmdobry
Refactored tests (#159)
c64384e 
* 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
@JustinBeckwith @alexander-fenster
test: remove appveyor config (#159)
36532b3
This was referenced Nov 17, 2022
Merged
Merged
sofisl pushed a commit that referenced this pull request Nov 18, 2022
@release-please @bcoe
chore: release 2.2.1 (#159)
0cf72a7
@sofisl sofisl mentioned this pull request Jan 17, 2023
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Jan 17, 2023
@jmdobry
Refactored tests (#159)
ceb4ef5 
* 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
@jmdobry
Refactored tests (#159)
426a3a5 
* 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
@renovate @JustinBeckwith
fix(deps): update dependency @google-cloud/storage to v2 (#159)
ec4a726
sofisl pushed a commit that referenced this pull request Jan 25, 2023
@jmdobry
Refactored tests (#159)
183f354 
* 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
@renovate @JustinBeckwith
fix(deps): update dependency @google-cloud/storage to v2 (#159)
33141b5
sofisl pushed a commit that referenced this pull request Jan 26, 2023
@release-please
chore: release 1.7.3 (#159)
d2bf244 
🤖 I have created a release \*beep\* \*boop\*
---
### [1.7.3](https://www.github.com/googleapis/nodejs-ai-platform/compare/v1.7.2...v1.7.3) (2021-06-29)


### Bug Fixes

* add C#, PHP and Ruby options for all AI Platform protos ([#158](https://www.github.com/googleapis/nodejs-ai-platform/issues/158)) ([da0babf](https://www.github.com/googleapis/nodejs-ai-platform/commit/da0babf54c6b074b8dc3d0354f8a57b9bc0cefc1))
* **deps:** google-gax v2.17.0 with mTLS ([#161](https://www.github.com/googleapis/nodejs-ai-platform/issues/161)) ([8e7d46f](https://www.github.com/googleapis/nodejs-ai-platform/commit/8e7d46f1252c4e89a663dd28b70b49bf269f091a))
---


This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
@sofisl sofisl mentioned this pull request Jan 26, 2023
Merged
4 tasks
@enterstudio enterstudio mentioned this pull request Apr 19, 2023
Open
@enterstudio enterstudio mentioned this pull request Jun 26, 2023
Open
sofisl pushed a commit that referenced this pull request Sep 14, 2023
@muraliQlogic @JustinBeckwith
docs(samples): Update samples to use async/await (#159)
ce3c142
@sofisl sofisl mentioned this pull request Sep 14, 2023
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@ryanseys @stephenplusplus @silvolu