Improvement - Improve the contribution guidelines

scania / corporate-ui

This repo will be archived in Q3 2021, please visit https://github.com/scania-digital-design-system

https://digitaldesign.scania.com/

25 stars 15 forks source link

Improvement - Improve the contribution guidelines #564

Closed mmexvr closed 4 years ago

mmexvr commented 4 years ago

Describe current situation
Describe what the current situation and what problem it is causing for this improvement Improve the documentation for how to fork so people that aren't used to github/git/fork can follow in a easy way

Describe the improvement
A clear and concise description of what kind of improvement you have in mind. Add more clear example how to fork

Screenshots
If applicable, add screenshots to help explain your ideas.

Additional context
Add any other context about the suggestion here. Based on feedback

mmexvr commented 4 years ago

Would be good to mention that people can't create a branch through our repo because of security reasons
Update the example part how to run that

mmexvr commented 4 years ago

Add that css should be in scania-theme in a more clear way

for example color
should use variables and so on var(--primary)
Mention more about global components(table/button) how they work if you are using them inside your new component. if you change a global component it will effect all other components that use global components

mmexvr commented 4 years ago

Add link to contriubtion guidelines in the template for PR

mmexvr commented 4 years ago

Add how to set the theme in the component with the store

mmexvr commented 4 years ago

Add how to test the branch

mmexvr commented 4 years ago

Add how to use boostrap inside components and how to use bootstrap ($.corporate-ui) in application