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

Added the Spec checklist to the docs #5555

Closed

Conversation

SanidhayaAgarwal
Copy link

🚀 Contribution to pnp/cli-microsoft365: Adding a Specification Checklist Document 🚀

Dear Maintainers and Contributors,

I am thrilled to submit this pull request, which introduces a valuable addition to our project's documentation. This enhancement enhances our collaborative development process by providing a detailed "Specification Checklist" document under the "Contributing" section.

📝 What's New?

Specification Checklist: The heart of this contribution is the meticulously crafted "Specification Checklist" document. It defines comprehensive specifications for both new commands and enhancements in the pnp/cli-microsoft365 project. This checklist will serve as a valuable resource to ensure consistency, quality, and adherence to best practices in our development efforts.

🚀 Why It Matters

  • Ensures Consistency: The checklist ensures that all new commands and enhancements follow a consistent naming convention, options structure, and more, aligning with our project's standards.
  • Quality Assurance: By adhering to these specifications, we can maintain and improve the overall quality of our CLI commands.
  • Enhances Collaboration: Clear guidelines benefit all contributors, whether seasoned or newcomers, fostering a more collaborative environment.
  • Streamlined Documentation: This document will complement our existing documentation, making it easier for contributors to understand and follow our development process.

🙌 Your Feedback Matters!

We encourage everyone to review the new "Specification Checklist" document and provide feedback. Your insights and suggestions are crucial in refining our development process further.

📚 How to Access

You can find the "Specification Checklist" document under the "Contributing" section in the left navigation sidebar of our documentation.

💪 Contributing to Our Community

We believe that an active and engaged community is the backbone of any open-source project. We welcome all contributors, regardless of experience level, and we appreciate your dedication to making this project even better!

Thank you for your time and consideration. Let's continue to build an outstanding CLI tool together.

Cheers to open source and collaboration! 🌟

Best Regards,
Sanidhaya Agarwal

@milanholemans milanholemans linked an issue Oct 9, 2023 that may be closed by this pull request
@SanidhayaAgarwal
Copy link
Author

Is it merged

@milanholemans
Copy link
Contributor

Hi @SanidhayaAgarwal like we agreed in the issue, could you add the content to the docs instead of the contribution.md file?
It should go under the contributing section: https://github.com/pnp/cli-microsoft365/tree/main/docs/docs/contribute

Also, you shouldn't modify too much to the sidebars.js. The only thing that you'll have to do is add the new page you've created over there.

@SanidhayaAgarwal
Copy link
Author

check once
@milanholemans

@SanidhayaAgarwal
Copy link
Author

Hi @SanidhayaAgarwal like we agreed in the issue, could you add the content to the docs instead of the contribution.md file? It should go under the contributing section: https://github.com/pnp/cli-microsoft365/tree/main/docs/docs/contribute

Also, you shouldn't modify too much to the sidebars.js. The only thing that you'll have to do is add the new page you've created over there.

do i have to add to all the files or create a separate file

@SanidhayaAgarwal
Copy link
Author

Hi @milanholemans now i have made all the changes as said by you and modified the sidebar.js. Please check and merge

@milanholemans
Copy link
Contributor

Hi @SanidhayaAgarwal, seems like your file is empty. When you look at the changed files of this PR, you'll see that you've added a file with no content and changed the entire sidebars.js` file.

In this PR you should only:

contributing: [
{
type: 'doc',
label: 'Contributing guide',
id: 'contribute/contributing-guide'
},
{
type: 'doc',
label: 'Environment setup',
id: 'contribute/environment-setup'
},
{
'Creating a new command': [
{
type: 'doc',
label: 'New command sample',
id: 'contribute/new-command/step-by-step-guide'
},
{
type: 'doc',
label: 'Command logic',
id: 'contribute/new-command/build-command-logic'
},
{
type: 'doc',
label: 'Unit tests',
id: 'contribute/new-command/unit-tests'
},
{
type: 'doc',
label: 'Help page',
id: 'contribute/new-command/writing-the-docs'
}
]
},
{
type: 'doc',
label: 'Adding a script sample',
id: 'contribute/script-sample/new-script-sample'
},
{
type: 'doc',
label: 'Debugging the CLI',
id: 'contribute/how-to-debug'
},
{
type: 'doc',
label: 'Creating a Pull Request',
id: 'contribute/creating-the-pr'
},
{
type: 'doc',
label: 'Pull Request review',
id: 'contribute/expect-during-pr'
}
],

@SanidhayaAgarwal
Copy link
Author

Hi @SanidhayaAgarwal, seems like your file is empty. When you look at the changed files of this PR, you'll see that you've added a file with no content and changed the entire sidebars.js` file.

In this PR you should only:

contributing: [
{
type: 'doc',
label: 'Contributing guide',
id: 'contribute/contributing-guide'
},
{
type: 'doc',
label: 'Environment setup',
id: 'contribute/environment-setup'
},
{
'Creating a new command': [
{
type: 'doc',
label: 'New command sample',
id: 'contribute/new-command/step-by-step-guide'
},
{
type: 'doc',
label: 'Command logic',
id: 'contribute/new-command/build-command-logic'
},
{
type: 'doc',
label: 'Unit tests',
id: 'contribute/new-command/unit-tests'
},
{
type: 'doc',
label: 'Help page',
id: 'contribute/new-command/writing-the-docs'
}
]
},
{
type: 'doc',
label: 'Adding a script sample',
id: 'contribute/script-sample/new-script-sample'
},
{
type: 'doc',
label: 'Debugging the CLI',
id: 'contribute/how-to-debug'
},
{
type: 'doc',
label: 'Creating a Pull Request',
id: 'contribute/creating-the-pr'
},
{
type: 'doc',
label: 'Pull Request review',
id: 'contribute/expect-during-pr'
}
],

Hey actually i have added a new file and made the changes in that portion itself in the sidebar. Ok i'll creat a new PR

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.

Add the Spec checklist to the docs
2 participants