Mention Coding Conventions in the development instructions
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.8k
- Forks
- 717
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 3
Description
Originally by @magi42
Setting up the Eclipse project preferences and the coding conventions files is not mentioned in the README.md for the Vaadin Framework project at https://github.com/vaadin/vaadin.
Such instructions should probably be in the "Set up extra workspace preferences" section. Please check if there's something else missing as well. The old instructions are at https://dev.vaadin.com/wiki/CodingConventions.
Perhaps this should be mentioned in the Contributing Code page as well.
Imported from https://dev.vaadin.com/ issue #19155
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 README.md and its “Set up extra workspace preferences” section, then review the Contributing Code page mentioned in the issue. Compare both with the old CodingConventions instructions and identify any missing setup details. Done means the relevant documentation includes the Eclipse project preferences and coding conventions setup, with other clearly missing items added if confirmed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100