-
Notifications
You must be signed in to change notification settings - Fork 59
Contribution Guidelines
Thank you for considering contributing to Fundamental Library Styles. It's people like you that make this such a great tool.
You must be aware of the Apache License (which describes contributions) and accept the Developer Certificate of Origin. This is common practice in major Open Source projects. To make this process as simple as possible, we are using CLA assistant for individual contributions. CLA assistant is an open source tool that integrates with GitHub very well and enables a one-click experience for accepting the CLA. For company contributors, special rules apply. See the respective section below for details.
Due to legal reasons, contributors will be asked to accept a DCO before they submit the first pull request to this projects, this happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.
If you've noticed a bug or have a question, search the issue tracker to see if someone else in the community has already created a ticket. If not, go ahead and open a new issue! Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behaviour that is not occurring. See Reporting an Issue.
If this is something you think you can fix, then fork Fundamental Styles and create a branch with a descriptive name.
A good branch name would be (where issue #325 is the ticket you're working on):
git checkout -b feature/325-japanese-translationAt this point, you're ready to make your changes! Feel free to ask for help, everyone is a beginner at first 😸
- Develop component template and SASS as a standalone component. For new components, see Creating a New Component
- Follow development guidelines around BEM structure and SASS
- Test in multiple browsers with no CSS dependencies
Any markup or CSS changes should begin with the test framework. The HTML created here will be used on the documentation site.
- Follow Download and Installation instructions in the
README - Run
npm run storybook - Go to localhost:6006
Read more about the
testframework and Visual Testing
If your update requires changes to the documentation. The documentation pages are used for testing too.
- Run
npm run storybook - Go to localhost:6006
Go to GitHub and make a Pull Request :D
In the subject of the pull request, use feat: to denote an enhancement, fix: to denote a bug fix, chore: for small configuration updates or docs: for documentation updates and briefly describe the bug fix or enhancement you are contributing.
Assign the Review as SAP/fundamental-styles.
A PR can only be merged into master by a maintainer if has passed all required status checks.