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

Create Wiki page with tips & tricks #55

Closed
lucdekens opened this issue Jan 9, 2019 · 5 comments
Closed

Create Wiki page with tips & tricks #55

lucdekens opened this issue Jan 9, 2019 · 5 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@lucdekens
Copy link
Contributor

To avoid that every contributor to this repo makes the same mistakes and falls into the same pitfalls, it would be nice to have a kind of FAQ.
This FAQ should contain guidelines, but also workarounds for known issues.

@SimeonGerginov
Copy link
Contributor

SimeonGerginov commented Jan 14, 2019

For the wiki page with tips and tricks do you have some initial questions you want to be answered there beside these in #60?

@lucdekens
Copy link
Contributor Author

In theory I would say all questions contributors might have, and that are not covered in the CONTRIBUTING.md file.
Mostly practical Q&A.
We already discussed quite a few in other issues and reviews.

My (personal) starting list

  • Suggest some tools to use?
  • How to follow/automate the formatting guidelines. For example, the placement of curly braces, and how to automate this in VSC (settings.json)
  • Practical guidelines for working with git and this repo
    • how this repo is set up and who manages it (merge-wise)
    • the minimum required git commands
    • possible GUI alternatives
  • How to write resources that require different levels of coding?
    • the ones where all functionality is covered by PowerCLI cmdlets
    • the ones where functionality that Get-View and ExtensionData
    • the ones where all with functionality that requires esxcli
  • How to design Unit tests for each of these, especially the mocking
  • What shall be covered in the Integration test? What am I testing in fact?
    ...

@SimeonGerginov
Copy link
Contributor

Ok, we will add them to the wiki page.

@lucdekens
Copy link
Contributor Author

The Wiki will in any case case be an organic document.
It will grow over time.

@SimeonGerginov
Copy link
Contributor

SimeonGerginov commented Jan 18, 2019

We have added the Tips & Tricks page to the Wiki. I will close this issue as the page is created but we will create another where request can be made about adding more sections and content to the page.

@SimeonGerginov SimeonGerginov added this to the 2.0-Consider milestone Apr 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants