Skip to content

Commit d5a6468

Browse files
committed
add PR template and style guide
1 parent c0b28ee commit d5a6468

File tree

2 files changed

+99
-0
lines changed

2 files changed

+99
-0
lines changed

PULL_REQUEST_TEMPLATE.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<!-- Thank you for contributing to @keyvaluesystems/react-multi-selection-ui-component! -->
2+
<!-- Before submitting a pull request, please review our contributing guidelines. -->
3+
4+
5+
6+
## Pull Request Checklist
7+
8+
9+
10+
- [ ] **Read the contributing guidelines.**
11+
- [ ] **Linked to an issue:** Fixes # (replace with the issue number, if applicable)
12+
- [ ] **Branch is up-to-date with the base branch:** `master`
13+
- [ ] **Changes pass tests locally:** `npm test` or `yarn test`
14+
- [ ] **Documentation has been updated, if necessary**
15+
- [ ] **Code follows the style guide of the project**
16+
17+
18+
## Description
19+
20+
21+
22+
<!-- Provide a brief description of your changes. -->
23+
24+
25+
26+
## Screenshots (if applicable)
27+
28+
29+
30+
<!-- Add screenshots or GIFs to help explain your changes. -->
31+
32+
33+
34+
## Additional Notes
35+
36+
37+
38+
<!-- Any additional information you want to provide that is not covered by the checklist or description. -->
39+
40+
41+
42+
## Related Issues or PRs
43+
44+
45+
46+
<!-- If your pull request is related to any issue(s) or other pull request(s), mention them here. -->
47+
48+
49+
50+
## Reviewer Guidelines
51+
52+
53+
54+
<!-- Suggest specific areas of the codebase that you would like the reviewer to focus on. -->
55+
56+
57+
58+
## Testing Instructions
59+
60+
61+
62+
<!-- Provide step-by-step instructions on how to test your changes. -->
63+
64+
65+
66+
## Checklist for Reviewers
67+
68+
69+
70+
- [ ] Code follows project conventions and style
71+
- [ ] Changes do not introduce new warnings or errors
72+
- [ ] Unit tests cover the changes
73+
- [ ] Documentation is updated
74+
75+
76+
## By submitting this pull request, I confirm that my contribution is made under the terms of the MIT License.

STYLE_GUIDELINES.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## SCSS Style Guidelines for @keyvaluesystems/react-multi-selection-ui-component
2+
3+
**Introduction**
4+
5+
As an open-source project utilizing SCSS, @keyvaluesystems/react-multi-selection-ui-component strives to maintain a consistent and well-structured codebase. These SCSS style guidelines serve as a reference for contributors, ensuring that their SCSS code adheres to established conventions and best practices.
6+
7+
**SCSS Coding Conventions**
8+
9+
- Organize SCSS files into a logical structure.
10+
- Use meaningful and descriptive names for variables, mixins, and classes.
11+
- Use SCSS nesting judiciously to organize complex styles.
12+
- Include comments to explain non-obvious logic and complex styles.
13+
- Utilize SCSS variables to define reusable values.
14+
- Employ a SCSS linting tool.
15+
- Should support devices with all resolutions
16+
- Follow CamelCase conventions for class names that concisely convey their purpose, enhancing code organization and readability
17+
- Adhere to the practice of reusing style classes to improve code organization and maintainability.
18+
19+
**Documentation Practices**
20+
21+
- Provide clear documentation for exported mixins and variables.
22+
- Include a README file within the SCSS directory if necessary.
23+
- Add comments to SCSS files.

0 commit comments

Comments
 (0)