👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to SF Java UI, which is hosted in the JsonSchema-JavaUI organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by the Open source project contributor convenant. By participating, you are expected to uphold this code. Please report unacceptable behavior to JsonSchema-JavaUI@github.com.
Schema Form is inspired by the nice JSON Form library and aims to be roughly compatible with it, especially its form definition. So what sets Schema Form apart from JSON Form?
- Schema Form integrates deeply with AngularJS and uses AngularJS conventions to handle forms.
- Schema Form uses tv4 for validation, making it compatible with version 4 of the JSON schema standard.
- By default, Schema Form generates Bootstrap 3-friendly HTML.
for more details please visit the official schema form web site or the github page
Thera are a few conventions that have developed over time around packages:
- New layout annotations must be added under io.asfjava.ui.core.form
- New layout generators must be added to io.asfjava.ui.core.generators
When we make a significant decision in how we maintain the project and what we can or cannot support, we will document it in the design document. If you have a question around how we do things, check to see if it is documented there. If it is not documented there, please open a new issue on the issue tracker and ask your question.
This section guides you through submitting a bug report for SF Java UI. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
Bugs are tracked as GitHub issues. After you've determined which cause your bug is related to, create an issue on that repository and provide the following information by filling in the template.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- don't just say what you did, but explain how you did it,
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
- If the problem is related to performance or memory, include a CPU profile capture
- If Chrome's developer tools pane is shown without you triggering it,
This section guides you through submitting an enhancement suggestion for SF Java UI, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
- Check if there's already an opened issue which provides that enhancement.
- Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
Enhancement suggestions are tracked as GitHub issues. Create an issue on that repository and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Explain why this enhancement would be useful
- Specify the version of the Angular Schema Form.
Unsure where to begin contributing to SF Java UI? You can start by looking help-wanted issues:
- Fill in the required template
- Do not include issue numbers in the PR title
- Include screenshots and animated GIFs in your pull request whenever possible.
- Follow the Java and Java 8 styleguides.
- Include thoughtfully-worded, well-structured JUnit specs. Run them using
mvn test. - Document new code based on the Documentation Styleguide
- Avoid platform-dependent code.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- When only changing documentation, include
[ci skip]in the commit description - Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 🚱
:non-potable_water:when plugging memory leaks - 📝
:memo:when writing docs - 🐧
:penguin:when fixing something on Linux - 🍎
:apple:when fixing something on macOS - 🏁
:checkered_flag:when fixing something on Windows - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 💚
:green_heart:when fixing the CI build - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies
- 🎨