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

Fixed mismatching node template names in README #278

Merged
merged 1 commit into from
Jan 21, 2022
Merged

Fixed mismatching node template names in README #278

merged 1 commit into from
Jan 21, 2022

Conversation

cactysman
Copy link
Contributor

@cactysman cactysman commented Jan 20, 2022

Description

The names for the Node.js templates in the README document were all named node14. This pull request fixes that.

Motivation and Context

The README can be a bit misleading at first without this change.

  • I have raised an issue to propose this change (required)

Which issue(s) this PR fixes

Fixes #277

How Has This Been Tested?

This change only affects documentation and requires no testing.

Types of changes

  • Documentation (non-breaking change)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Version change (see: Impact to existing users)

Impact to existing users

This change fixes invalid documentation and attempts to solve potential confusion with it.

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s
  • I have added tests to cover my changes.

  • All new and existing tests passed.

    Honestly I did not test this, but if anything should break here, I'm 100% certain it's not my fault 😮

Signed-off-by: Cactys <git@cactys.dev>
@derek
Copy link

derek bot commented Jan 20, 2022

Thank you for your contribution. unfortunately, one or more of your commits are missing the required "Signed-off-by:" statement. Signing off is part of the Developer Certificate of Origin (DCO) which is used by this project.

Read the DCO and project contributing guide carefully, and amend your commits using the git CLI. Note that this does not require any cryptography, keys or special steps to be taken.

💡 Shall we fix this?

This will only take a few moments.

First, clone your fork and checkout this branch using the git CLI.

Next, set up your real name and email address:

git config --global user.name "Your Full Name"
git config --global user.email "you@domain.com"

Finally, run one of these commands to add the "Signed-off-by" line to your commits.

If you only have one commit so far then run: git commit --amend --signoff and then git push --force.
If you have multiple commits, watch this video.

Check that the message has been added properly by running "git log".

@derek derek bot removed the no-dco label Jan 20, 2022
Copy link
Member

@alexellis alexellis left a comment

Choose a reason for hiding this comment

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

LGTM

@alexellis
Copy link
Member

Thanks for filling out the PR template. Glad you were able to get the DCO sorted too 👍

For any future issues, please don't delete the issue template next time 😄

@alexellis alexellis merged commit 657717e into openfaas:master Jan 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Typo] Node template naming in README is wrong
2 participants