Change readme gif and contributing guidelines. Closes #5564 #5570
Conversation
|
Thank @Aaron-Junker for opening the PR. We will review it ASAP. |
There was a problem hiding this comment.
I think it is a good start but we should recheck the details.
I am not sure if clearing out the guidance is the way to go here. @milanholemans what is your take on that?
Also the new gif is ok but it just seems oldfashioned. @pnp/cli-for-microsoft-365-maintainers anyone any other feedback on that?
| - **DO NOT** surprise us with big PR's. Instead file an issue & start a discussion so we can agree on a direction before you invest a large amount of time. | ||
| - **DO NOT** commit code you didn't write. | ||
| - **DO NOT** submit PR's that refactor existing code without a discussion first. | ||
| You can find these guidelines here: <https://pnp.github.io/cli-microsoft365/contribute/contributing-guide> |
There was a problem hiding this comment.
Since it's .md we may hide the link behind a label. I guess there is no need to present the link right?
| You can find these guidelines here: <https://pnp.github.io/cli-microsoft365/contribute/contributing-guide> | |
| You can find these [guidelines here](https://pnp.github.io/cli-microsoft365/contribute/contributing-guide) |
| @@ -2,53 +2,4 @@ | |||
|
|
|||
| We appreciate that you're interested in helping with moving the project forward. Before you submit your first PR, please read the following guide. We'd hate to see you work on something that someone else is already working on, something that we agreed not to do or something that doesn't match the project. | |||
|
|
|||
| Sharing is caring! | |||
There was a problem hiding this comment.
I don't believe the aim of this issue was to remove most of the guidance here but rather update it to align with the current approach and add a link to full details.
@milanholemans as you are the author of the issue then maybe you may confirm.
in many places the Contribuiting.md is tracked and shown as a pointer to contribution guidance. If we just clear out this file and only leave the link it will only become problematic for someone who is in search of this guidance as now he or she would need to actually first redirect to contribuiting.md and then redirect again to docs.
There was a problem hiding this comment.
I haven't read the entire contributing page, but I guess most of the things there are still relevant and we should only update links to the GH wiki.
There was a problem hiding this comment.
TBH I think we could do better than that. The blue terminal seems kinda oldschool and reminds me of Windows PowerShell (the newer PowerShell 7 is also black terminal).
I think it would be best if we could show that CLI works in multiple shells. In the past we had something similar done by @garrytrinder, maybe you could advise.
@Aaron-Junker if you want we may leave the current gif for now and in this PR only focus on updating the guidance in order not to keep it on hold for much longer
|
@Aaron-Junker are you working on this PR? Do you need any help? |
@Adam-it Still working on it. Just had little time last month. |
sure thing 👍. Thanks for the response and keeping us updated. You rock 🤩 |
|
@Aaron-Junker Happy New Year 🤩🥳 |
|
Closing due to lack of response 😢 |
I hope the quality of the new gif is ok enough.