Contributor setup should mention preferred white space settings
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 11
- Forks
- 22
- Avg merge
- 7d 3h
- Merged PRs (30d)
- 2
Description
Here https://sap.github.io/spartacus-docs/contributor-setup/ we should mention what the preferred white space settings are and how to preferably configure the contributors git client.
See https://www.git-scm.com/book/en/v2/Customizing-Git-Git-Configuration, 'Formatting and White space'
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the contributor setup page at https://sap.github.io/spartacus-docs/contributor-setup/ and consult Git's “Formatting and White space” configuration guidance. Document the preferred whitespace settings and how contributors should configure their Git client; the issue is done when both instructions are present on that page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100