Skip to content

Commit 7c83607

Browse files
LuisFerLCCLuisFerLCC
committed
Update .github directory
1 parent bdc1048 commit 7c83607

File tree

10 files changed

+463
-5
lines changed

10 files changed

+463
-5
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
<div align="center" style="margin-bottom: 0.5rem">
2+
<a href="https://www.contributor-covenant.org/" title="Contributor Covenant homepage">
3+
<img src="https://raw.githubusercontent.com/EthicalSource/contributor_covenant/HEAD/static/images/logo-inverted.svg" width="50" />
4+
</a>
5+
</div>
6+
7+
<h1 align="center">Contributor Covenant Code of Conduct</h1>
8+
9+
## Our Pledge
10+
11+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our community include:
18+
19+
- Demonstrating empathy and kindness toward other people
20+
- Being respectful of differing opinions, viewpoints, and experiences
21+
- Giving and gracefully accepting constructive feedback
22+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
23+
- Focusing on what is best not just for us as individuals, but for the overall community
24+
25+
Examples of unacceptable behavior include:
26+
27+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
28+
- Trolling, insulting or derogatory comments, and personal or political attacks
29+
- Public or private harassment
30+
- Publishing others' private information, such as a physical or email address, without their explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a professional setting
32+
33+
## Enforcement Responsibilities
34+
35+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
36+
37+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
38+
39+
## Scope
40+
41+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
42+
43+
## Enforcement
44+
45+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
46+
47+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
48+
49+
## Enforcement Guidelines
50+
51+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
52+
53+
### 1. Correction
54+
55+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
56+
57+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
58+
59+
### 2. Warning
60+
61+
**Community Impact**: A violation through a single incident or series of actions.
62+
63+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
64+
65+
### 3. Temporary Ban
66+
67+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
68+
69+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
70+
71+
### 4. Permanent Ban
72+
73+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
74+
75+
**Consequence**: A permanent ban from any sort of public interaction within the community.
76+
77+
## Attribution
78+
79+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
80+
81+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][mozilla coc].
82+
83+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][faq]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
84+
85+
[homepage]: https://www.contributor-covenant.org
86+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
87+
[mozilla coc]: https://github.com/mozilla/diversity
88+
[faq]: https://www.contributor-covenant.org/faq
89+
[translations]: https://www.contributor-covenant.org/translations

‎.github/CONTRIBUTING.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ If you wish to contribute to the **Float Toolkit for React** source code, feel f
88

99
## Steps
1010

11-
1. Fork and clone the repository, and checkout the corresponding branch (`docs` for documentation, `master` for anything else). **DO NOT** modify the `stable` branch.
12-
1. Make your changes.
13-
1. Run `npm run build` (or VSCode task _NPM: Build_) to build the package (you can use `npm link` to try it locally).
14-
1. [Submit a pull request](https://github.com/float-toolkit/react/compare).
11+
1. Refer to the [documentation](https://float-toolkit.web.app) and [README file](https://github.com/float-toolkit/react/blob/master/README.md) to make sure the error is actually a bug and not a mistake of your own.
12+
1. Make sure the issue hasn't already been reported or suggested.
13+
1. Fork and clone the repository, and checkout the corresponding branch (`docs` for documentation, `master` for anything else). **DO NOT** modify the `stable` branch.
14+
1. Make your changes (add or modify tests and documentation comments as necessary to cover your changes).
15+
1. Run `npm run build` (or VSCode task _NPM: Build_) to run the tests and build the package (you can use `npm link` to try it locally).
16+
1. [Submit a pull request](https://github.com/float-toolkit/react/compare).

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<div align="center" style="margin-bottom: 0.5rem">
2+
<img src="https://raw.githubusercontent.com/float-toolkit/react/HEAD/media/ftreact.svg" width="100" />
3+
</div>
4+
5+
<h1 align="center">New Issue</h1>
6+
7+
## Before you go ANY further...
8+
9+
- Refer to the [documentation](https://float-toolkit.web.app) and [README file](https://github.com/float-toolkit/react/blob/master/README.md) to make sure the error is actually a bug and not a mistake of your own.
10+
- Please help us process your issue efficiently and in detail by using one of our [issue templates](https://github.com/float-toolkit/react/issues/new/choose).
11+
12+
Thank you for contributing to the **Float Toolkit** codebase!

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
name: Bug Report
2+
description: Is the package not working as intended?
3+
title: BUG - (brief description)
4+
labels:
5+
- 🐞 Bug
6+
assignees: LuisFerLCC
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
<div align="center" style="margin-bottom: 0.5rem">
13+
<img src="https://raw.githubusercontent.com/float-toolkit/react/HEAD/media/ftreact.svg" width="100" />
14+
</div>
15+
16+
<h1 align="center">Bug Report</h1>
17+
18+
- type: dropdown
19+
id: affects-core-package
20+
attributes:
21+
label: Affects core package
22+
description: Does this bug affect `@float-toolkit/core` as well?
23+
options:
24+
- "Yes"
25+
- "No"
26+
27+
- type: input
28+
id: package-version
29+
attributes:
30+
label: Package version
31+
description: Which package version are you using? You can check it in your `package.json` file or by running `npm list <package>`.
32+
placeholder: X.X.X
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: description
38+
attributes:
39+
label: Description
40+
description: |
41+
Please describe the bug and how to reproduce it in as much detail as possible.
42+
You can also attach images or log files here.
43+
placeholder: |
44+
Steps to reproduce:
45+
1.
46+
2.
47+
3.
48+
...
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: code-sample
54+
attributes:
55+
label: Code sample
56+
description: |
57+
If possible, include a reproducible code sample. The sample should be minimal (with no unnecessary code) but complete.
58+
NOTE: This input will be automatically formatted into JavaScript/TypeScript code.
59+
render: TypeScript
60+
placeholder: |
61+
import useFloatToolkit from "@float-toolkit/react";
62+
63+
// in function component
64+
const { add, output } = useFloatToolkit();
65+
66+
- type: textarea
67+
id: expected-behavior
68+
attributes:
69+
label: Expected behavior
70+
validations:
71+
required: true
72+
73+
- type: textarea
74+
id: actual-behavior
75+
attributes:
76+
label: Actual behavior
77+
validations:
78+
required: true
79+
80+
- type: dropdown
81+
id: priority
82+
attributes:
83+
label: Priority
84+
description: How critical is this bug? (please be realistic)
85+
options:
86+
- Minor bug (annoying, but not crucially broken)
87+
- Medium bug (needs attention)
88+
- Major bug (must be fixed immediately)
89+
validations:
90+
required: true
91+
92+
- type: checkboxes
93+
id: contribution-guidelines
94+
attributes:
95+
label: Contribution guidelines
96+
description: By submitting this issue, you agree that...
97+
options:
98+
- label: This is a bug, not you [asking for support](https://github.com/float-toolkit/react/discussions/categories/q-a).
99+
required: true
100+
- label: You have read the [documentation](https://float-toolkit.web.app) and [README file](https://github.com/float-toolkit/react/blob/master/README.md), and made sure this is not intended behavior.
101+
required: true
102+
- label: The issue has not already been reported.
103+
required: true
104+
- label: You are following the project's [Code of Conduct](https://github.com/float-toolkit/react/blob/master/.github/CODE_OF_CONDUCT.md) and [contribution guidelines](https://github.com/float-toolkit/react/blob/master/.github/CONTRIBUTING.md).
105+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: Documentation
5+
url: https://float-toolkit.web.app
6+
about: Please check the documentation before filing new issues.
7+
8+
- name: Support
9+
url: https://github.com/float-toolkit/react/discussions/categories/q-a
10+
about: Need help? Ask on GitHub discussions!
11+
12+
- name: Core package
13+
url: https://github.com/float-toolkit/core/issues/new/choose
14+
about: For issues related to @float-toolkit/core

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Feature Request
2+
description: Do you have a suggestion or an idea for a new feature?
3+
title: SUGGESTION - (brief description)
4+
labels:
5+
- ✨ Enhancement
6+
assignees: LuisFerLCC
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
<div align="center" style="margin-bottom: 0.5rem">
13+
<img src="https://raw.githubusercontent.com/float-toolkit/react/HEAD/media/ftreact.svg" width="100" />
14+
</div>
15+
16+
<h1 align="center">Feature Request</h1>
17+
18+
- type: dropdown
19+
id: targets-core-package
20+
attributes:
21+
label: Targets core package
22+
description: Should this feature also be added in `@float-toolkit/core`?
23+
options:
24+
- "Yes"
25+
- "No"
26+
27+
- type: textarea
28+
id: description
29+
attributes:
30+
label: Description
31+
description: |
32+
Please describe the suggestion in as much detail as possible.
33+
You can also attach images or text files here.
34+
placeholder: |
35+
This new feature would be very welcome...
36+
The lack of ___ is frustrating...
37+
___ should behave like this instead...
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: example-use-cases
43+
attributes:
44+
label: Example use cases
45+
description: When and where would this feature be useful?
46+
placeholder: This would be useful in situations where...
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: other-alternatives
52+
attributes:
53+
label: Other alternatives
54+
description: Have you considered any other possible approaches?
55+
56+
- type: checkboxes
57+
id: contribution-guidelines
58+
attributes:
59+
label: Contribution guidelines
60+
description: By submitting this issue, you agree that...
61+
options:
62+
- label: This is a suggestion, not you [asking for support](https://github.com/float-toolkit/react/discussions/categories/q-a).
63+
required: true
64+
- label: You have read the [documentation](https://float-toolkit.web.app) and [README file](https://github.com/float-toolkit/react/blob/master/README.md) and made sure this is not already implemented.
65+
required: true
66+
- label: The issue has not already been suggested.
67+
required: true
68+
- label: This new feature will not break any existing code.
69+
required: true
70+
- label: This feature fits with Float Toolkit's philosophy and goals.
71+
required: true
72+
- label: You are following the project's [Code of Conduct](https://github.com/float-toolkit/react/blob/master/.github/CODE_OF_CONDUCT.md) and [contribution guidelines](https://github.com/float-toolkit/react/blob/master/.github/CONTRIBUTING.md).
73+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<div align="center" style="margin-bottom: 0.5rem">
2+
<img src="https://raw.githubusercontent.com/float-toolkit/react/HEAD/media/ftreact.svg" width="100" />
3+
</div>
4+
5+
<h1 align="center">New Pull Request</h1>
6+
7+
## First things first...
8+
9+
- Make sure to read the [contribution guidelines](https://github.com/float-toolkit/react/blob/master/.github/CONTRIBUTING.md) before you go any further.
10+
- Is there an issue related to your changes? If so, link to it here. If not, create an issue before submitting your pull request in order to discuss.
11+
12+
## (How) do your changes work?
13+
14+
- Run all existing tests in the repository and make sure all of them pass.
15+
- Add or modify tests as needed to cover your changes.
16+
- Finally, add or modify documentation comments as needed.
17+
18+
Thank you for contributing to the **Float Toolkit** codebase!

0 commit comments

Comments
 (0)