Skip to content
This repository was archived by the owner on Apr 1, 2020. It is now read-only.

Advise how to fix #4

Merged
merged 8 commits into from
Dec 18, 2017
Merged

Advise how to fix #4

merged 8 commits into from
Dec 18, 2017

Conversation

z0al
Copy link
Owner

@z0al z0al commented Dec 16, 2017

Before:

There were the following issues with this Pull Request

  • Commit: de1c17986d9ba6abb5b1f2e28b4513e539c2df86
    • ✖ message may not be empty
    • ✖ type may not be empty
  • Commit: 698b7c9e5c7bba4d55403d2ff03769cfa0efc00f
    • ✖ type may not be empty

After:

There were the following issues with this Pull Request

  • Commit: de1c17986d9ba6abb5b1f2e28b4513e539c2df86
    • ✖ message may not be empty
    • ✖ type may not be empty
  • Commit: 698b7c9e5c7bba4d55403d2ff03769cfa0efc00f
    • ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.


🤖 This comment is autogenerated. If you noticed some issues please report them here. Happy coding!

I only provided a hint for how to actually change commit message. I think the best place to know how to write correct commit messages should be the repository contributing guidelines.

@JasonEtco
Copy link

This looks great! 🎉 So glad you've found a way to help users correct their commit messages.

The only note I would give you is to also link to the repository's contributing guidelines, if possible. You can use the API to check if they have one, in the root of the repo or in the .github folder. That is, if you've enabled the "Read repo contents" permission - if you haven't, that's fine, it's just a nice touch :P

Also, you might as well use that footer message to point them to the app's repo; if people need to, they can learn a bit more about why its doing what its doing.

@z0al
Copy link
Owner Author

z0al commented Dec 17, 2017

Thanks @JasonEtco for the quick response 👍

Also, you might as well use that footer message to point them to the app's repo

Isn't the footer message actually points to the app's repo?

@JasonEtco
Copy link

Isn't the footer message actually points to the app's repo?

Yep! But I meant you could say something like:

🤖 This comment was generated by commitlint[bot]. Please report issues here. Happy coding!

@z0al
Copy link
Owner Author

z0al commented Dec 17, 2017

Oh, that looks shorter and awesome ❤️

@JasonEtco
Copy link

@ahmed-taj cool! Also note that the second link points to /issues, just to be a little more specific ✨

@z0al
Copy link
Owner Author

z0al commented Dec 18, 2017

I don't have Read repo contents permission enabled, so I will skip linking to the repository contributing guidelines for now ;)

@z0al z0al merged commit 75daa1b into master Dec 18, 2017
@z0al z0al deleted the advise-how-to-fix branch December 18, 2017 04:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants