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

Improve contributors' experience with more documentation. #693

Closed
gcruchon opened this issue Oct 6, 2020 · 2 comments · Fixed by #729
Closed

Improve contributors' experience with more documentation. #693

gcruchon opened this issue Oct 6, 2020 · 2 comments · Fixed by #729
Assignees
Labels
Type: Enhancement New feature or request
Milestone

Comments

@gcruchon
Copy link
Contributor

gcruchon commented Oct 6, 2020

Issue and Steps to Reproduce

Documentation needed for a better help to constributors.

Versions

1.3.21

Expected

  • List of supported browsers, for contributor to test with them
  • More details about scripts and what they do
  • Some How-Tos (like: how to make your CSS changes available in the storybook)
  • Some Guidelines (test guidelines: "what to test and how", a detail of the architecture of a component)
  • Some useful tools (like VM for testing on various browsers)

Actual

Contributor have to dig into the code, to understand more how things work.

@arnaudforaison
Copy link
Contributor

CONTRIBUTING.md file seems to explain some of script do. Not enough ? How do more ?
Design system, have guidelines.
Tools like ... ?

@arnaudforaison arnaudforaison added the Type: Enhancement New feature or request label Oct 11, 2020
@gcruchon
Copy link
Contributor Author

If it's OK for you, you can assign this issue to me and I can submit a first version that we can all improve during the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants