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

Fixes #1457 - Refer to Yarn consistently in Clay README #1454

Merged
merged 1 commit into from
Jan 21, 2019
Merged

Fixes #1457 - Refer to Yarn consistently in Clay README #1454

merged 1 commit into from
Jan 21, 2019

Conversation

wincent
Copy link
Contributor

@wincent wincent commented Jan 18, 2019

The Clay README instructs people to install and use Yarn, and we ship with a yarn.lock, but we don't consistently use yarn in the commands that we show in the README; this commit fixes that for consistency.

Tested the commands manually to make sure they all run as intended.

Related: https://issues.liferay.com/browse/IFI-421

@matuzalemsteles
Copy link
Member

hey @gregory-bretall, Thanks for that. But only a small change, when they are issues of Jira we open a issue in Github and we refer to this issue in the Jira for track, in the commit message we refer to the issue of Github.

Can you create an issue for this and if possible do the same with the other PR? Then I think we'll be ready to give merged. Please let me know if this got too confusing 😅.

@wincent
Copy link
Contributor Author

wincent commented Jan 18, 2019

Can you create an issue for this and if possible do the same with the other PR? Then I think we'll be ready to give merged. Please let me know if this got too confusing

I think that makes sense. Let me tell you how I think it works and you can tell me if I understood correctly:

  • In Jira, ticket contains link to GitHub issue.
  • In GitHub issue, there is no link back to Jira. (Question: do we at least mention the Jira ticket number?)
  • In GitHub PR/commit, reference the GitHub issue.

It sounds like it is mostly a uni-directional link from Jira to GitHub, not a bi-directional one in both ways.

@matuzalemsteles
Copy link
Member

Yes, that's correct.

In GitHub issue, there is no link back to Jira. (Question: do we at least mention the Jira ticket number?)

About the description, I see no problem in refer to issue in Jira. We do not have a pattern on that part, feel free.

@wincent wincent changed the title [IFI-421] Refer to Yarn consistently in Clay README Fix #1457: Refer to Yarn consistently in Clay README Jan 21, 2019
The Clay README instructs people to install and use Yarn, and we ship
with a yarn.lock, but we don't consistently use `yarn` in the commands
that we show in the README; this commit fixes that for consistency.

Tested the commands manually to make sure they all run as intended.

Related: https://issues.liferay.com/browse/IFI-421
@wincent
Copy link
Contributor Author

wincent commented Jan 21, 2019

Ok @matuzalemsteles, I just created a related issue and updated the PR title and commit message to refer to the issue.

@wincent wincent changed the title Fix #1457: Refer to Yarn consistently in Clay README Fixes #1457 - Refer to Yarn consistently in Clay README Jan 21, 2019
@matuzalemsteles
Copy link
Member

Thanks @wincent!!

@matuzalemsteles matuzalemsteles merged commit 1c6e4b6 into liferay:develop Jan 21, 2019
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.

2 participants