Skip to content

Contribution Guidelines

Jump to bottom
Jenna Badanowski edited this page Mar 29, 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.

1. 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.

  • If possible, use the relevant bug report templates to create the issue.

2. 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

3. 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 😸

4. 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.

5. Run the documentation

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

6. 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.

7. Keeping your Pull Request updated

If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.

To learn more about rebasing in Git, there are a lot of good resources but here's the suggested workflow:

git checkout feature/325-japanese-translation
git pull --rebase upstream master
git push --force-with-lease feature/325-japanese-translation

OR

git remote add upstream https://github.com/SAP/fundamental.git
git checkout master
git pull upstream master

Then update your feature branch from your local copy of master, and push it!

git checkout feature/325-japanese-translation
git rebase master
git push --set-upstream origin feature/325-japanese-translation

8. Merging a PR (maintainers only)

A PR can only be merged into master by a maintainer if:

  • It is passing CI.
  • It has been approved by at least two maintainers. If it was a maintainer who opened the PR, only one extra approval is needed.
  • It has no requested changes.
  • There are no conflicts with the master branch.

Any maintainer is allowed to merge a PR if all of these conditions are met.

Helpful Resources

Home

Developer Resources

Consumer Resources

Clone this wiki locally