Skip to content

Conversation

@n-rodriguez
Copy link
Contributor

@myii
Copy link
Contributor

myii commented Apr 30, 2019

@n-rodriguez Thanks for this PR. I've tested it in my own fork and it appears to be working fine. There are just a few minor changes I'd request.

  • Fix the non-conforming commit message.
    • I.e. Update README.
    • Probably better to squash into the one commit.
  • Update the README to show the badges and include the related information, as shown in this diff.
  • Use commitlint.config.js identical to upstream.
    • Whitespace is different.
  • Use release.config.js identical to upstream.
    • Whitespace is different.
    • The amount of change here showed up as different sections in meld.
    • Becomes difficult to confirm everything is OK.
    • Will be difficult to maintain if changes are ever needed to be propagated across all formulas.

Copy link
Contributor

@myii myii left a comment

Choose a reason for hiding this comment

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

As mentioned in my comment.

@n-rodriguez
Copy link
Contributor Author

@myii done!

@myii myii merged commit db9e480 into saltstack-formulas:master May 2, 2019
@myii
Copy link
Contributor

myii commented May 2, 2019

Merged this excellent PR, @n-rodriguez!

@n-rodriguez
Copy link
Contributor Author

n-rodriguez commented May 2, 2019

One more question : the link to the contribute page is broken :

:ref:`How to contribute <CONTRIBUTING>` 

@myii
Copy link
Contributor

myii commented May 2, 2019

@n-rodriguez The explanation about this is here: https://template-formula.readthedocs.io/en/latest/README.html#contributing-to-this-repo.

Basically, it's a Sphinx link that works on Read the Docs. The original plan was to automatically prepare documentation for each formula there. However, that's changed a little since then and all of these documentation files will be centralised instead, rather than repeat identical content in 300+ README files! So it's a little ugly for the time being, until we can get to that solution.

@n-rodriguez
Copy link
Contributor Author

ok! thank you!

@saltstack-formulas-travis

🎉 This PR is included in version 0.1.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants