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

Updates README with new gif and additional changes. Closes #5564 #6523

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 7 additions & 49 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,12 @@
# Contribution guidelines

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.
Ready to make the CLI for Microsoft 365 even better? That’s awesome, we’d love your help! Here’s the quick guide to getting involved (Full [Contributing guide](https://pnp.github.io/cli-microsoft365/contribute/contributing-guide)):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Ready to make the CLI for Microsoft 365 even better? That’s awesome, we’d love your help! Here’s the quick guide to getting involved (Full [Contributing guide](https://pnp.github.io/cli-microsoft365/contribute/contributing-guide)):
Ready to make CLI for Microsoft 365 even better? That’s awesome, we’d love your help! Check the [contributing guide](https://pnp.github.io/cli-microsoft365/contribute/contributing-guide) the get involved quickly.


Sharing is caring!
- **Got a new command idea?** First, check the [issue list](https://github.com/pnp/cli-microsoft365/issues). Not there? Create an issue and let’s brainstorm!
- **Want to improve a command?** Great! Submit an issue first so we can align on the changes before you dive in.
- **Found a bug?** Let us know how to reproduce it in an issue.
- **Fixing typos?** Small, focused fixes are always appreciated, quick wins for everyone!

## You have an idea for a new command
**Pro tips:** Keep your fork up to date, work in feature branches, and don’t forget to include tests with your new features. Got a big idea? Start a discussion first to keep everything smooth.

Awesome! Good ideas are invaluable for every product. Before you start hacking away, please check if there is no similar idea already listed in the [issue list](https://github.com/pnp/cli-microsoft365/issues). If not, please create a new issue describing your idea. Once we agree on the feature scope and architecture, the feature will be ready for building. Don't hesitate to mention in the issue if you'd like to build the feature yourself. If it's the first time you're building a command see the [guidance article](https://github.com/pnp/cli-microsoft365/wiki/Adding-a-command) explaining in detail what you will need at minimum.

## You have a suggestion for improving an existing command

Nothing is perfect. If you have an idea how to improve an existing command or the CLI, let us know by submitting an issue in the [issue list](https://github.com/pnp/cli-microsoft365/issues). Some things are done for a reason, but some are not. Let's discuss what you think and see how the project could be improved for everyone.

## You've found a bug

Bugs happen. When you find a bug, please have a look at the [issue list](https://github.com/pnp/cli-microsoft365/issues) if a similar bug has already been logged. If not, let us know what doesn't work and how we can reproduce it. If we can't reproduce your bug, we will ask you for clarification, which will only make it longer to fix it.

## Fixing typos

Typos are embarrassing! Most PR's that fix typos will be accepted immediately. In order to make it easier to review the PR, please narrow the focus instead of sending a huge PR of fixes.

## Tips

Before contributing:

- ensure that the **main** branch on your fork is in sync with the original **cli-microsoft365** repository

```sh
# assuming you are in the folder of your locally cloned fork....
git checkout main

# assuming you have a remote named `upstream` pointing to the official **cli-microsoft365** repo
git fetch upstream

# update your local main to be a mirror of what's in the main repo
git pull --rebase upstream main
```

- create a feature branch for your change. If you'll get stuck on an issue or merging your PR will take a while, this will allow you to have a clean main branch that you can use for contributing other changes

```sh
git checkout -b my-contribution
```

## DO's & DON'Ts

- **DO** follow the same project and test structure as the existing project.
- **DO** include tests when adding new functionality and features. When fixing bugs, start with adding a test that highlights how the current behavior is broken.
- **DO** keep discussions focused. When a new or related topic comes up it's often better to create new issue than to side track the conversation.
- **DO NOT** submit PR's for coding style changes.
- **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.
For the full scoop, check out our [Contributing guide](https://pnp.github.io/cli-microsoft365/contribute/contributing-guide). Let’s make something amazing together!
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<a href="#microsoft-365--power-platform-community">Microsoft 365 & Power Platform Community</a>
</p>
<p align="center">
<img alt="CLI for Microsoft 365" src="./docs/docs/images/cli-microsoft365.gif" height="500" />
<img alt="CLI for Microsoft 365" src="./docs/docs/images/cli-microsoft365.gif" style="max-height: 500px;max-width: 100%;height: auto;width: auto;object-fit: contain;" />
</p>

## Features
Expand Down Expand Up @@ -216,9 +216,9 @@ When you execute any `m365` command from the terminal, it will now use your loca

We love to accept contributions.

If you want to get involved with helping us grow the CLI, whether that is suggesting or adding a new command, extending an existing command or updating our documentation, we would love to hear from you.
If you want to get involved with helping us grow the CLI, whether that is suggesting or adding a new command, extending an existing command, or updating our documentation, we would love to hear from you.

Checkout our [Wiki](https://github.com/pnp/cli-microsoft365/wiki) for guides on how to contribute to this project.
Check out our [Contributing Guide](https://pnp.github.io/cli-microsoft365/contribute/contributing-guide) for detailed information on how to contribute to this project.

## Need Help?

Expand All @@ -238,5 +238,3 @@ CLI for Microsoft 365 is a [Microsoft 365 & Power Platform Community](https://pn
## Disclaimer

**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**

![telemetry](https://telemetry.sharepointpnp.com/cli-microsoft365/readme)
Copy link
Contributor

Choose a reason for hiding this comment

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

If I'm not mistaken, we are using this to track telemetry.

Binary file modified docs/docs/images/cli-microsoft365.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading