This repository has been archived by the owner on Oct 19, 2023. It is now read-only.
First pass at adding a contributing section #138
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MattMSumner
force-pushed
the
mms-contributing
branch
2 times, most recently
from
8743cac
to
34b58be
Compare
SViccari
reviewed
Dec 18, 2018
| If you haven't already, create a [developer account] on hubspot. You'll want to | ||
| [create an app] and a [test account] as well. Then, create a new file, `.env` in | ||
| the root of the repo. Inside you'll need to add an [app id], a HubSpot user id, | ||
| an [api key] and an [oauth access token]; |
There was a problem hiding this comment.
an [api key] and an [oauth access token]
Should this be an "or"? I believe only one means of authentication is necessary.
an [api key]
andor an [oauth access token]
There was a problem hiding this comment.
Unfortunately not. For the test suite to pass you need both as we have tests that use both methods to authenticate.
MattMSumner
force-pushed
the
mms-contributing
branch
from
23e467b
to
7e318a0
Compare
Why: We would like to make it easier for contributors to get started with the code base and empower meaningful contributions. This PR: * Adds a ton of documentation to the Contributing section of the readme around testing newly added endpoints to the library. * Changes the contributors section to link to the GitHub contributors page. * Adds a `build` script for getting setup with the project a smoother experience. * Adds a `.env.example` file to show what we expect a typical `.env` to look like.
MattMSumner
force-pushed
the
mms-contributing
branch
from
7e318a0
to
ece3931
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.