You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CODE_OF_CONDUCT.md
+13-41Lines changed: 13 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,21 +8,9 @@ We pledge to act and interact in ways that contribute to an open, welcoming, div
8
8
9
9
## Our Standards
10
10
11
-
Examples of behavior that contributes to a positive environment for our community include:
11
+
Examples of behavior that contributes to a positive environment for our community include:*Demonstrating empathy and kindness toward other people*Being respectful of differing opinions, viewpoints, and experiences*Giving and gracefully accepting constructive feedback*Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience*Focusing on what is best not just for us as individuals, but for the overall community
12
12
13
-
* Demonstrating empathy and kindness toward other people
14
-
* Being respectful of differing opinions, viewpoints, and experiences
15
-
* Giving and gracefully accepting constructive feedback
16
-
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
-
* Focusing on what is best not just for us as individuals, but for the overall community
18
-
19
-
Examples of unacceptable behavior include:
20
-
21
-
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22
-
* Trolling, insulting or derogatory comments, and personal or political attacks
23
-
* Public or private harassment
24
-
* Publishing others' private information, such as a physical or email address, without their explicit permission
25
-
* Other conduct which could reasonably be considered inappropriate in a professional setting
13
+
Examples of unacceptable behavior include:*The use of sexualized language or imagery, and sexual attention or advances of any kind*Trolling, insulting or derogatory comments, and personal or political attacks*Public or private harassment*Publishing others' private information, such as a physical or email address, without their explicit permission*Other conduct which could reasonably be considered inappropriate in a professional setting
26
14
27
15
## Enforcement Responsibilities
28
16
@@ -44,40 +32,24 @@ All community leaders are obligated to respect the privacy and security of the r
44
32
45
33
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46
34
47
-
### 1. Correction
48
-
49
-
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50
-
51
-
**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.
52
-
53
-
### 2. Warning
54
-
55
-
**Community Impact**: A violation through a single incident or series of actions.
56
-
57
-
**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.
58
-
59
-
### 3. Temporary Ban
60
-
61
-
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62
-
63
-
**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.
35
+
### 1. Correction**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.**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
64
36
65
-
### 4. Permanent Ban
37
+
### 2. Warning**Community Impact**: A violation through a single incident or series of actions.**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
66
38
67
-
**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.
39
+
### 3. Temporary Ban**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.**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
68
40
69
-
**Consequence**: A permanent ban from any sort of public interaction within the community.
41
+
### 4. Permanent Ban**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.**Consequence**: A permanent ban from any sort of public interaction within the community
70
42
71
43
## Attribution
72
44
73
-
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].
45
+
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.htm>l][v2.1].
74
46
75
47
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
76
48
77
-
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].
49
+
For answers to common questions about this code of conduct, see the FAQ at [<https://www.contributor-covenant.org/fa>q][FAQ]. Translations are available at [<https://www.contributor-covenant.org/translation>s][translations].
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+51-61Lines changed: 51 additions & 61 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,61 +2,52 @@
2
2
3
3
First off, thank you for taking the time to contribute to the Stacks ecosystem ❤️
4
4
5
-
> **Note**
6
-
> The likelihood is high that the repo you are working on is either a Stack or Stacks itself. In both cases, you will be exposed to a meshup of technologies, like [Vue][vue], [Vite][vite], [Tauri][tauri], [Nitro][nitro], and [Bun][bun].
5
+
>**Note**> The likelihood is high that the repo you are working on is either a Stack or Stacks itself. In both cases, you will be exposed to a meshup of technologies, like [Vue][vue], [Vite][vite], [Tauri][tauri], [Nitro][nitro], and [Bun][bun].
7
6
8
7
## 💭 Knowledge
9
8
10
9
### TypeScript
11
10
12
-
It's important to note early on that these projects are written with [TypeScript][typescript]. If you're unfamiliar with it (or any strongly typed languages such as Java) then this may feel like a slight roadblock. However, there's never a truly perfect time to start learning it, so ... why not today using well-written codebases as your playground?
13
-
14
-
_Don't be discouraged. You will get by learning TypeScript on-the-fly as you review some of the examples within the codebase. It's easy to get started—the code is, we hope, very approachable (and readable)._
15
-
16
-
### Architecture
11
+
It's important to note early on that these projects are written with [TypeScript][typescript]. If you're unfamiliar with it (or any strongly typed languages such as Java) then this may feel like a slight roadblock. However, there's never a truly perfect time to start learning it, so ... why not today using well-written codebases as your playground?_Don't be discouraged. You will get by learning TypeScript on-the-fly as you review some of the examples within the codebase. It's easy to get started—the code is, we hope, very approachable (and readable)._### Architecture
17
12
18
13
An understanding of the framework architecture and design will help if you're looking to contribute long-term, or if you are working on a "more complex" PR. Browse the source and read our documentation to get a better sense of how it is structured. The documentation is very thorough and can be used as your progressive guide as you're learning more about Stacks.
19
14
20
-
Feel free to ask any question _(Twitter, Discord, or GitHub Discussions)_, we would love to elaborate & collaborate.
15
+
Feel free to ask any question_(Twitter, Discord, or GitHub Discussions)_, we would love to elaborate & collaborate.
21
16
22
17
### Stacks/Core Setup
23
18
24
-
Are you interested in contributing to the Stacks codebase?
25
-
26
-
**Working on your first Pull Request?** You can learn how from this free series [How to Contribute to an Open Source Project on GitHub][pr-beginner-series].
19
+
Are you interested in contributing to the Stacks codebase?**Working on your first Pull Request?**You can learn how from this free series [How to Contribute to an Open Source Project on GitHub][pr-beginner-series].
27
20
28
21
Head over to the [repository][stacks] on GitHub and click the Fork button in the top right corner. After the project has been forked, run the following commands in your terminal:
29
22
30
23
```bash
31
-
# Replace {github-username} with your GitHub username.
All the framework tests are stored within the`./.stacks/tests`project folder. When adding or updating functionality, please ensure it is covered through our test suite. Ensure so by running`buddy test`.
144
+
All the framework tests are stored within the`./.stacks/tests`project folder. When adding or updating functionality, please ensure it is covered through our test suite. Ensure so by running`buddy test`.
154
145
155
-
When working on an individual Stack, tests are stored within the `./tests`project folder & it is recommended to write tests (when useful). Bu
146
+
When working on an individual Stack, tests are stored within the `./tests`project folder & it is recommended to write tests (when useful). Bu
156
147
157
148
## ✍️ Commit
158
149
159
-
Stacks uses [semantic commit messages][semantic-commit-style] to automate package releases. No worries, you may not be aware what this is or how it works—just let Buddy guide you. Stacks automated the commit process for you, simply run`buddy commit`in your terminal and follow the instructions.
150
+
Stacks uses [semantic commit messages][semantic-commit-style] to automate package releases. No worries, you may not be aware what this is or how it works—just let Buddy guide you. Stacks automated the commit process for you, simply run`buddy commit`in your terminal and follow the instructions.
160
151
161
-
For example,
152
+
For example,```bash
153
+
154
+
# Add all changes to staging to be committed
162
155
163
-
```bash
164
-
# Add all changes to staging to be committed.
165
156
git add .
166
157
167
-
# Commit changes.
158
+
# Commit changes
159
+
168
160
buddy commit
169
161
170
-
# Push changes up to GitHub.
171
-
git push
172
-
```
162
+
# Push changes up to GitHub
173
163
174
-
_By following these minor steps, Stacks is able to automatically release new versions & generate relating local & remote changelogs._
164
+
git push
175
165
176
-
## 🎉 Pull Request
166
+
```_By following these minor steps, Stacks is able to automatically release new versions & generate relating local & remote changelogs._## 🎉 Pull Request
177
167
178
168
When you're all done, head over to the [repository][stacks], and click the big green `Compare & Pull Request` button that should appear after you've pushed changes to your fork.
179
169
180
170
Don't expect your PR to be accepted immediately or even accepted at all. Give the community time to vet it and see if it should be merged. Please don't be disheartened if it's not accepted. Your contribution is appreciated more than you can imagine, and even a unmerged PR can teach us a lot ❤️
0 commit comments