Skip to content

Contribution Guidelines

Jump to bottom
Jenna Badanowski edited this page Apr 24, 2019 · 8 revisions

Contributing

Thank you for considering contributing to SAP Fiori Fundamentals. It's people like you that make this such a great tool.

Did you find a bug?

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 behavior that is not occurring. See Reporting an Issue.

Fork & create a branch

If this is something you think you can fix, then fork Fundamentals 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-translation

Implement your fix or feature

At 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 and with common libs like Bootstrap

Run the test framework/playground

Any markup or CSS changes should begin the test framework. The component test framework loads only core.scss and individual component .scss files. The HTML created here will be used on the documentation site.

Read more about the test framework and Visual Testing

Run the documentation site

If your update requires changes to the documentation. The docs CSS is compiled from the source SASS.

Make a Pull Request

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/fiori-fundamentals.

Merging a PR (maintainers only)

A PR can only be merged into master by a maintainer if has passed all required status checks.

Helpful Resources

Home

Developer Resources

Consumer Resources

Clone this wiki locally