Skip to content

Commit c7a1b5c

Browse files
ihorihor
authored
Merge pull request #9 from make-software/kara/oss-bits-2
Open-Source bits and pieces - 2
2 parents 6d3dca1 + 758e0a2 commit c7a1b5c

6 files changed

Lines changed: 305 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: 🐞 Bug report
3+
about: Report an issue with CSPR.design components or utilities
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: eugenebelov
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**Component(s) affected**
13+
Which CSPR.design component(s) are involved in this issue? (e.g., CSPR, BodyText, FlexColumn, etc.)
14+
15+
**To Reproduce**
16+
Steps to reproduce the behavior:
17+
1. Import component '...'
18+
2. Use props '...'
19+
3. Render in '...'
20+
4. See error
21+
22+
**Expected behavior**
23+
A clear and concise description of what you expected to happen.
24+
25+
**Code example**
26+
Please provide a minimal code example that reproduces the issue:
27+
28+
```jsx
29+
// Your code here
30+
```
31+
32+
**Screenshots**
33+
If applicable, add screenshots to help explain your problem, especially for visual/styling issues.
34+
35+
**Environment information:**
36+
- CSPR.design version: [e.g. 1.2.3]
37+
- React version: [e.g. 18.2.0]
38+
- TypeScript version: [e.g. 4.9.5]
39+
- Bundler: [e.g. Vite 4.0.0, Webpack 5.75.0]
40+
- Browser: [e.g. Chrome 108, Firefox 107, Safari 16]
41+
- Operating System: [e.g. macOS 13.1, Windows 11, Ubuntu 22.04]
42+
43+
**Additional context**
44+
Add any other context about the problem here. Include any error messages, console logs, or related issues.
45+
46+
**Storybook reference**
47+
If the issue is visible in [CSPR.design Storybook](https://storybook.cspr.design), please provide a link to the relevant story.
48+
49+
**Are you willing to submit a pull request to fix this bug?**
50+
- [ ] Yes
51+
- [ ] No
52+

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: ❓ Ask a question or discuss an idea
4+
url: https://t.me/CSPRDevelopers
5+
about: Ask your questions and discuss your ideas in the CSPR Developers Group
6+
- name: 📖 View Storybook Documentation
7+
url: https://storybook.cspr.design
8+
about: Explore component examples and documentation in our interactive Storybook
9+
- name: 📦 NPM Package
10+
url: https://www.npmjs.com/package/@make-software/cspr-design
11+
about: View the CSPR.design package on NPM
12+

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
name: ✨ Feature request
3+
about: Suggest a new component or feature for CSPR.design
4+
title: "[FEATURE] "
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
**Search keywords**
10+
Please list keywords you used to search for existing similar requests:
11+
12+
**Is your feature request related to a problem?**
13+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
14+
15+
**Describe the solution you'd like**
16+
A clear and concise description of what you want to happen.
17+
18+
**Component type**
19+
What type of component or feature are you requesting?
20+
- [ ] New UI component
21+
- [ ] New utility function
22+
- [ ] Enhancement to existing component
23+
- [ ] New styling/theming feature
24+
- [ ] Casper-specific utility
25+
- [ ] Other (please specify)
26+
27+
**Use case**
28+
Describe the specific use case or scenario where this feature would be helpful. How would it be used in a Casper dApp or application?
29+
30+
**Design references**
31+
If applicable, provide links to design specifications, mockups, or examples from other libraries that demonstrate the desired behavior.
32+
33+
**Examples**
34+
Provide examples of how you envision using this feature:
35+
36+
```jsx
37+
// Example usage
38+
```
39+
40+
**Additional context**
41+
Add any other context, screenshots, or examples about the feature request here.
42+
43+
**Priority**
44+
How important is this feature for your project?
45+
- [ ] Critical - blocking development
46+
- [ ] High - would significantly improve development experience
47+
- [ ] Medium - nice to have
48+
- [ ] Low - minor improvement
49+
50+
**Are you willing to contribute to this feature?**
51+
- [ ] Yes, I can implement this feature
52+
- [ ] Yes, I can help with testing/feedback
53+
- [ ] No, but I would be happy to provide requirements/feedback
54+

‎.github/developer-certificate-of-origin‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Developer Certificate of Origin
2+
Version 1.1
3+
4+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
5+
660 York Street, Suite 102,
6+
San Francisco, CA 94110 USA
7+
8+
Everyone is permitted to copy and distribute verbatim copies of this
9+
license document, but changing it is not allowed.
10+
11+
Developer's Certificate of Origin 1.1
12+
13+
By making a contribution to this project, I certify that:
14+
15+
(a) The contribution was created in whole or in part by me and I
16+
have the right to submit it under the open source license
17+
indicated in the file; or
18+
19+
(b) The contribution is based upon previous work that, to the best
20+
of my knowledge, is covered under an appropriate open source
21+
license and I have the right under that license to submit that
22+
work with modifications, whether created in whole or in part
23+
by me, under the same open source license (unless I am
24+
permitted to submit under a different license), as indicated
25+
in the file; or
26+
27+
(c) The contribution was provided directly to me by some other
28+
person who certified (a), (b) or (c) and I have not modified
29+
it.
30+
31+
(d) I understand and agree that this project and the contribution
32+
are public and that a record of the contribution (including all
33+
personal information I submit with it, including my sign-off) is
34+
maintained indefinitely and may be redistributed consistent with
35+
this project or the open source license(s) involved.

‎.github/pull_request_template.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
* Resolves: # <!-- related github issue -->
2+
3+
### Summary
4+
5+
<!-- Provide a brief description of the changes in this PR -->
6+
7+
### Type of Change
8+
9+
- [ ] 🐛 Bug fix
10+
- [ ] ✨ New feature
11+
- [ ] 🔧 Component enhancement
12+
- [ ] 📚 Documentation update
13+
- [ ] 🎨 Style/UI changes
14+
- [ ] ⚙️ Misc
15+
16+
### Component(s) Affected
17+
18+
<!-- List the components that are modified, added, or removed -->
19+
- [ ] New component: `ComponentName`
20+
- [ ] Modified component: `ComponentName`
21+
- [ ] Removed component: `ComponentName`
22+
23+
### Changes Made
24+
25+
<!-- Describe the specific changes made in this PR -->
26+
27+
### Testing
28+
29+
- [ ] Unit tests added/updated
30+
- [ ] Storybook stories added/updated
31+
- [ ] Manual testing completed
32+
- [ ] Accessibility testing performed
33+
- [ ] Cross-browser testing (if applicable)
34+
- [ ] Responsive design testing (if applicable)
35+
36+
### Storybook
37+
38+
- [ ] New stories created for new components
39+
- [ ] Existing stories updated to reflect changes
40+
- [ ] All component variants documented
41+
- [ ] Props table is accurate and complete
42+
- [ ] Examples demonstrate proper usage
43+
44+
### Breaking Changes
45+
46+
<!-- If this PR introduces breaking changes, describe them here and provide migration guidance -->
47+
48+
### Screenshots/Videos
49+
50+
<!-- If applicable, add screenshots or videos to demonstrate the changes -->
51+
52+
### TODO
53+
54+
- [ ] ...
55+
56+
### Checklist
57+
58+
- [ ] Code is properly formatted (Prettier/ESLint)
59+
- [ ] All commits are signed
60+
- [ ] TypeScript types are properly defined
61+
- [ ] Components follow design system guidelines
62+
- [ ] Accessibility requirements met (WCAG compliance)
63+
- [ ] Bundle size impact considered
64+
- [ ] Tests included/updated or not needed
65+
- [ ] Storybook stories included/updated or not needed
66+
- [ ] Documentation updated or not required
67+
- [ ] No console errors or warnings
68+
- [ ] Backward compatibility maintained (or breaking changes documented)
69+

‎CONTRIBUTING.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributing to CSPR.design
2+
3+
The following is a set of rules and guidelines for contributing to this repo. Please feel free to propose changes to this document in a pull request.
4+
5+
## Submitting issues
6+
7+
If you have questions about how to use CSPR.design, please direct these to our community channels:
8+
* [CSPR Developers Group](https://t.me/CSPRDevelopers) - Ask questions and discuss ideas with the community
9+
* [Storybook Documentation](https://storybook.cspr.design) - Explore component examples and API documentation
10+
11+
### Guidelines
12+
* Please search the existing issues first, it's likely that your issue was already reported or even fixed.
13+
- Go to the main page of the repository, click "issues" and type any word in the top search/command bar.
14+
- You can also filter by appending e.g. "state:open" to the search string.
15+
- More info on [search syntax within GitHub](https://help.github.com/articles/searching-issues)
16+
* Use the appropriate issue template for your submission:
17+
- 🐞 **Bug report** - For reporting issues with components
18+
- ✨ **Feature request** - For suggesting new components or features
19+
20+
## Contributing to CSPR.design
21+
22+
All contributions to this repository are considered to be licensed under Apache License 2.0.
23+
24+
### Workflow for bug fixes:
25+
* Check open issues and unmerged pull requests to make sure the topic is not already covered elsewhere
26+
* Fork the repository
27+
* Do your changes on your fork
28+
* Make sure to add or update relevant test cases
29+
* Update Storybook stories if your changes affect component behavior or props
30+
* Test your changes in Storybook to ensure they work as expected
31+
* Create a pull request, with a suitable title and description, referring to the related issue
32+
33+
### Workflow for new components:
34+
* Check existing issues and discussions to ensure the component is needed and aligns with the design system
35+
* Create or update the component following our coding standards
36+
* Add comprehensive Storybook stories demonstrating all component variants and use cases
37+
* Include TypeScript definitions with proper JSDoc comments
38+
* Add unit tests covering component functionality
39+
* Update documentation if necessary
40+
* Create a pull request with detailed description of the new component
41+
42+
### Workflow for documentation improvements:
43+
* Identify areas where documentation can be improved
44+
* Update Storybook stories, README files, or inline code comments
45+
* Ensure examples are accurate and follow current best practices
46+
* Test that all code examples work correctly
47+
* Submit a pull request with clear description of documentation changes
48+
49+
### Code Standards
50+
51+
* **TypeScript**: All components must be written in TypeScript with proper type definitions
52+
* **Styling**: Use styled-components following our theming system
53+
* **Testing**: Include unit tests for all new functionality
54+
* **Storybook**: Every component must have comprehensive Storybook stories
55+
* **Accessibility**: Ensure components meet WCAG accessibility guidelines
56+
* **Performance**: Consider bundle size impact and rendering performance
57+
58+
### Sign your work
59+
60+
We use the Developer Certificate of Origin (DCO) as an additional safeguard for the CSPR.design project. This is a well established and widely used mechanism to assure contributors have confirmed their right to license their contribution under the project's license.
61+
62+
Please read [developer-certificate-of-origin](https://github.com/make-software/cspr-design/blob/main/.github/developer-certificate-of-origin).
63+
64+
If you can certify it, then just add a line to every git commit message:
65+
66+
```
67+
Signed-off-by: Random J Developer <random@developer.example.org>
68+
```
69+
70+
Use your real name (sorry, no pseudonyms or anonymous contributions).
71+
72+
If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`. You can also use git [aliases](https://git-scm.com/book/tr/v2/Git-Basics-Git-Aliases) like `git config --global alias.ci 'commit -s'`. Now you can commit with `git ci` and the commit will be signed.
73+
74+
## Community
75+
76+
We welcome contributions from developers building in the Casper ecosystem! Join our community:
77+
78+
* **[CSPR Developers Group](https://t.me/CSPRDevelopers)** - Main community chat for questions and discussions
79+
* **[GitHub Issues](https://github.com/make-software/cspr-design/issues)** - Bug reports and feature requests
80+
* **[Storybook](https://storybook.cspr.design)** - Component documentation and examples
81+
82+
Thank you for contributing to CSPR.design and helping build a better developer experience for the Casper ecosystem! 🚀
83+

0 commit comments

Comments
 (0)