chore(docs): Add contributing and pr/issue templates #21
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <!--- Provide a general summary of the issue in the Title above --> | ||
|
|
||
| ## Current Behavior | ||
| <!--- If describing a bug, tell us what is broken --> | ||
| <!--- If suggesting a change/improvement tell us what is missing from the SDK as it is currently --> | ||
|
|
||
| ## Expected Behavior | ||
| <!--- If describing a bug, tell us how the SDK should behave without the bug --> | ||
| <!--- If you're suggesting changes, outline your idea here --> | ||
|
|
||
| ## Possible Solution | ||
| <!--- Optional, but helpful! Use this field to suggest bug solutions or change impementation details. Feel free to get technical. --> | ||
|
|
||
| ## Steps to Reproduce (for bugs) | ||
| <!--- Provide a link to a live example, or an unambiguous set of steps to --> | ||
| <!--- reproduce this bug. Include code to reproduce, if relevant --> | ||
| * Link to your project or codepen: | ||
| 1. | ||
| 2. | ||
| 3. | ||
| 4. | ||
|
|
||
| ## Screenshots (if appropriate): | ||
|
|
||
| ## Your Environment | ||
| <!--- Please include any relevant environmental information here. (SDK version, node version, browser etc.) --> | ||
| * SDK version: | ||
| * Node version: | ||
| * Browser name and version: | ||
| * Operating system: | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| <!--- Provide a general summary of your changes in the Title above --> | ||
|
There was a problem hiding this comment. We need to mention that the PR needs to follow these commit guidelines: https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines. Specifically the title needs to |
||
|
|
||
| ## Description | ||
| <!--- Describe your changes in detail --> | ||
|
There was a problem hiding this comment. Description needs to also include |
||
| <!--- Don't forget to note any issues here with fixes #<issue number> --> | ||
|
There was a problem hiding this comment. Can you put quotes around |
||
|
|
||
| ## How Has This Been Tested? | ||
| <!--- Please describe in detail how you tested your changes. --> | ||
|
There was a problem hiding this comment. How about adding:
|
||
|
|
||
| ## Screenshots (if appropriate): | ||
|
|
||
| ## Checklist: | ||
| <!--- Please mark an `x` in all the boxes that apply. --> | ||
| <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
| - [ ] I have read the **CONTRIBUTING** document. | ||
|
There was a problem hiding this comment. I wonder if you can link to the There was a problem hiding this comment. does it need to be a relative path since this file is nested in .github/ ? is there a way to test these readmes out before merging? There was a problem hiding this comment. I've honestly never done a template so I don't know what it would ultimately be relative too. This is all new to me so I'm excited! 🎉 There was a problem hiding this comment. Upside, if it doesn't work we can quickly push a change that fixes it. 😅 |
||
| - [ ] I have updated the documentation accordingly. | ||
| - [ ] I have added tests to cover my changes. | ||
| - [ ] I have run yarn validate to ensure that tests, typescript and linting are all in order. | ||
|
There was a problem hiding this comment. This one isn't really necessary since it gets run in Travis automatically for the PR There was a problem hiding this comment. I think its still nice to have people run the tests though, might encourage more passing prs in our pr queue |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| #Contributing | ||
|
|
||
| Thank you for your interest in contributing to Eventbrite's Javascript SDK! | ||
|
|
||
| ###Table of Contents | ||
| * [Workflow](#workflow) | ||
| * [Setup](#setup) | ||
| * [Branches](#using-branches-to-submit-changes) | ||
| * [Keeping up to date](#keeping-your-local-repo-up-to-date) | ||
| * [Creating issues](#creating-issues) | ||
| * [Working on and submitting changes](#working-on-and-submitting-changes) | ||
| * [Steps to submit](#steps-to-submit) | ||
|
|
||
| ## Workflow | ||
|
|
||
| ### Setup | ||
|
|
||
| 1. Fork the repository | ||
|
There was a problem hiding this comment. Can you link "Fork the repository" to: https://help.github.com/articles/fork-a-repo/ |
||
| 2. Clone your new forked repository to your local computer | ||
| 3. Set the Eventbrite repository as your branches upstream branch | ||
| `git remote add upstream https://github.com/eventbrite/eventbrite-sdk-javascript.git` | ||
| 4. Navigate to the root directory of your newly cloned repository | ||
| (for mac `cd /path/to/eventbrite-sdk-javascript`) | ||
| 5. `yarn install` to install local dependencies | ||
|
There was a problem hiding this comment. I guess we need to add "install Yarn" to part of the setup? By the way, in markdown, you can number each one like There was a problem hiding this comment. nice tip on the list! i'll just make everything 1. I'll link docs to installing yarn |
||
|
|
||
| ### Using branches to submit changes | ||
| To work on changes to the Eventbrite repository, create a new branch on your local repository. `git checkout -b <your-new-branch-name>` | ||
|
|
||
|
|
||
| ### Keeping your local repo up to date | ||
| To ensure your branch never gets out of sync with Eventbrite's master, ensure that you have your upstream set properly (see the [Setup](#setup) step) | ||
|
|
||
| 1. `git checkout master` (you may have to stash or commit your local changes if on a new branch) | ||
|
There was a problem hiding this comment. link to this doc on stashing? https://git-scm.com/book/en/v1/Git-Tools-Stashing |
||
| 2. `git pull upstream master` | ||
| 3. `git checkout <your-new-branch-name>` | ||
| 4. `git rebase master` | ||
| 5. If you've stashed changes, unstash them now, otherwise your branch should now be up to date | ||
|
|
||
| Always try to keep your master 'clean' by only pulling changes directly from upstream into your master branch and rebasing those changes onto your working branch. | ||
|
|
||
| It is always a good idea to pull the upstream branch in to your master branch before creating a new feature branch to work from. This will minimize the chances of encountering merge conflicts. | ||
|
|
||
| ## Creating Issues | ||
| Create issues to File bugs, changes, and proposals. | ||
|
There was a problem hiding this comment. nit: |
||
|
|
||
| Before opening a new issue, please [search][issues] to see if there has been previous discussion about the same feature or issue. If so, please contribute to the discussion there. | ||
|
|
||
| If nothing is found, feel free to [open a new issue][issues] and fill out the issue template to the best of your ability. | ||
|
|
||
| ## Working on and submitting changes | ||
| When starting on improvements or new features that are non-trivial, it is always a good idea to first discuss the changes you wish to implement by [opening a github issue][issues] before getting started. | ||
|
|
||
| If you've found a bug or feature you'd like to work on in our [github issue tracker][issues], please comment on the issue to let others know that you'd like to work on it. | ||
|
|
||
| While implementing fixes, please try to change as little code as possible. This helps speed up the review process and helps diminish the chance of additional bugs. | ||
|
|
||
| Please try to conform to the coding style of the code base. | ||
|
There was a problem hiding this comment. Not sure how specific we want to be put, but either a link to the coding style or how they could verify that. ie There was a problem hiding this comment. Code gets automatically formatted on commit, so they should be good there. And then linting runs in Travis as part of There was a problem hiding this comment. I think much like validating the title, we can probably find something to validate the the format is proper. Something like |
||
|
|
||
| ###Steps to submit: | ||
|
|
||
| 1. Please ensure that your changes are fully covered by one or more unit test/s. | ||
|
There was a problem hiding this comment. lol thank you, that looked weird to me |
||
| 2. Check to make sure that your changes are documented properly (inline comments for interesting lines, READMEs, etc.) | ||
| 3. Run `yarn validate` to ensure that all tests pass, the linter is satisfied and your changes are typescript compliant. | ||
| 4. PR titles must be prefixed by the type of changes the PR contains followed by the scope of what the pr touches. Please use one of `feat, fix, docs, style, refactor, perf, test, chore` as the prefix. The scope is the the direct product your changes affect. Example: `chore(build): Add encrypted ssh key for semantic-release` because its a chore and it touches the build. | ||
| * For multiple scope items, you can comma separate 2 or 3 but if there are more than that please use a `*` instead. | ||
|
There was a problem hiding this comment. There was a problem hiding this comment. Yes, I believe that would be helpful. We should probably add badge[s] to the readme that can give some of this context quickly as someone is looking at the package. There was a problem hiding this comment. There's a |
||
| 5. Please use a [closing issue keyword](https://help.github.com/articles/closing-issues-using-keywords/) to indicate the issue that your fix addresses in the description section of the pull request template. Example: `fixes #32` to close issue #32 | ||
|
|
||
|
|
||
| [issues]: https://github.com/eventbrite/eventbrite-sdk-javascript/issues | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,7 +24,7 @@ Read more on [getting a token](https://www.eventbrite.com/developer/v3/api_overv | |
|
|
||
| ## Contributing | ||
|
|
||
| Check out our contributing document [here](https://github.com/eventbrite/eventbrite-sdk-javascript/blob/master/CONTRIBUTING.md) | ||
|
There was a problem hiding this comment. Can you do:
Also you can just do |
||
|
|
||
| ## Project philosophy | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you move the
part to the end? I really want folks to do this part 😄