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

fix: correct demo url on readme.md file #580

Merged
merged 2 commits into from
Jan 12, 2021
Merged

Conversation

lmuzquiz
Copy link
Contributor

@lmuzquiz lmuzquiz commented Jan 8, 2021

updated demo url to codepen example

Hello, and thanks for contributing to drift! 🎉🙌

Before submitting a pull request, please make sure the following is done:

  1. Fork the repository and create your branch from main.
  2. Run npm install in the repository root.
  3. If you've fixed a bug or added code that should be tested, add tests!
  4. Ensure the test suite passes (npm run test). Tip: npm run --watch is helpful in development.
  5. Format your code with prettier (npm run format). Don't worry too much if you haven't done this, we have a bot that will do this for you when you submit a PR.
  6. Fill out the template below and delete everything above the line.

Learn more about contributing: https://github.com/imgix/drift/blob/main/CONTRIBUTING.md

tldr

There are three main goals in this document, depending on the nature of your PR:

  • description: please tell us about your PR
  • checklist: please review the checklist that is most closely related to your PR
  • contributors list: you're one of us now, please add yourself to package.json and let the world know!

The following sections provide more detail on each.

Improve this document

Please don't hesitate to ask questions for clarification, or to make suggestions (or a pull request) to improve this document.

delete everything above this line

BREAKING CHANGE: description

Does this PR contain a breaking change? If yes, please update this description on the line above to include a short description of the breaking change. If no, please delete this line and the line above.

Description

To help the project's maintainers and community to quickly understand the nature of your pull request, please create a description that incorporates the following elements:

  • [] what is accomplished by the PR
  • [] if there is something potentially controversial in your pr, please take a moment to tell us about your choices

Checklist

Please use the checklist that is most closely related to your PR (you only need to use one checklist, and you can skip items that aren't applicable or don't make sense):

Fixing typos

Documentation

  • The PR title is in the conventional commit format: e.g. chore(readme): updated documentation for ___
  • Add your info to the contributors array in package.json!

Bug Fix

  • All existing unit tests are still passing (if applicable)
  • Add new passing unit tests to cover the code introduced by your PR
  • Update the readme
  • Update or add any necessary API documentation
  • Add some steps so we can test your bug fix
  • The PR title is in the conventional commit format: e.g. fix(<area>): fixed bug #issue-number
  • Add your info to the contributors array in package.json!

New Feature

  • If this is a big feature with breaking changes, consider opening an issue to discuss first. This is completely up to you, but please keep in mind that your PR might not be accepted.
  • Run unit tests to ensure all existing tests are still passing
  • Add new passing unit tests to cover the code introduced by your PR
  • Update the readme
  • Add some steps so we can test your cool new feature!
  • The PR title is in the conventional commit format: e.g. feat(<area>): added new way to do this cool thing #issue-number
  • Add your info to the contributors array in package.json!

Steps to Test

A code example or a set of steps is preferred.

Related issue: [e.g. #42]

Code:

// A standalone JS example of what the PR solves

A link to a codepen is also an option.

Steps:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See that the error has been fixed

delete everything below this line

Conventional Commit Spec

PR titles should be in the format <type>(<scope>): <description>. For example: chore(readme): fix typo

type can be one of feat, fix, test, or chore.
scope is optional, and can be anything.
description should be a short description of the change, in past tense.

package.json contributors

Add yourself!

When adding your information to the contributors array in package.json, please use the following format (provide your name or username at a minimum, the other fields are optional):

full name or username <email@address.com> (https://website.com)

Example

// -- package.json --
{
  "name": "drift",
  "contributors": [
    "Frederick Fogerty <frederick.fogerty@gmail.com> (https://github.com/frederickfogerty)",
    "Jon Smith <jon.smith@jonsmith.com> (https://github.com/jonsmith)",
    "helenjones"
  ]
}

updated demo url to codepen example
@lmuzquiz lmuzquiz requested a review from a team as a code owner January 8, 2021 16:34
@commit-lint
Copy link

commit-lint bot commented Jan 8, 2021

Contributors

lmuzquiz

Commit-Lint commands

You can trigger Commit-Lint actions by commenting on this PR:

  • @Commit-Lint merge patch will merge dependabot PR on "patch" versions (X.X.Y - Y change)
  • @Commit-Lint merge minor will merge dependabot PR on "minor" versions (X.Y.Y - Y change)
  • @Commit-Lint merge major will merge dependabot PR on "major" versions (Y.Y.Y - Y change)
  • @Commit-Lint merge disable will desactivate merge dependabot PR
  • @Commit-Lint review will approve dependabot PR
  • @Commit-Lint stop review will stop approve dependabot PR

@lmuzquiz lmuzquiz closed this Jan 8, 2021
@lmuzquiz lmuzquiz changed the title updated demo url to codepen example fix: correct demo url on readme.md file Jan 8, 2021
@lmuzquiz lmuzquiz reopened this Jan 8, 2021
@sherwinski sherwinski linked an issue Jan 8, 2021 that may be closed by this pull request
Copy link
Contributor

@sherwinski sherwinski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, thanks a lot @lmuzquiz!

@sherwinski sherwinski merged commit 72fa50e into strawdynamics:main Jan 12, 2021
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.

Demo url on readme.md file points to 404 error
2 participants