forked from open-sauced/.github
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: added all @open-sauced community files
- Loading branch information
Showing
9 changed files
with
332 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
name: 🐛 Bug report | ||
about: Create a bug report to help us improve Open Sauced 🍕 | ||
title: "Bug: " | ||
labels: 👀 needs triage, 🐛 bug | ||
--- | ||
|
||
<!-- Before creating a bug report, try disabling browser extensions to see if the bug is still present. --> | ||
|
||
### Describe the bug | ||
|
||
<!-- A clear and concise description of what the bug is. --> | ||
|
||
### To Reproduce | ||
|
||
<!-- Steps to reproduce the behavior: --> | ||
|
||
<!-- 1. Go to '...' --> | ||
<!-- 2. Click on '....' --> | ||
<!-- 3. Scroll down to '....' --> | ||
<!-- 4. See error --> | ||
|
||
### Expected behavior | ||
|
||
<!-- A clear and concise description of what you expected to happen. --> | ||
|
||
### Screenshots | ||
|
||
<!-- If applicable, add screenshots to help explain your problem. --> | ||
|
||
### Desktop | ||
|
||
- OS: | ||
- Browser: | ||
- Version: | ||
|
||
### Smartphone | ||
|
||
- Device: | ||
- OS: | ||
- Browser: | ||
- Version: | ||
|
||
### Additional context | ||
|
||
<!-- Add any other context about the problem or helpful links here. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: ❓ Ask a question | ||
url: https://discord.com/invite/U2peSNf23P | ||
about: Ask questions about open source onboarding |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
name: 🚀 Feature request | ||
about: Suggest an idea for this project 💡 | ||
title: "Feature: " | ||
labels: 👀 needs triage, 💡 feature | ||
--- | ||
|
||
### Is your feature request related to a problem? Please describe. | ||
|
||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --> | ||
|
||
### Describe the solution you'd like | ||
|
||
<!-- A clear and concise description of what you want to happen. --> | ||
|
||
### Describe alternatives you've considered | ||
|
||
<!-- A clear and concise description of any alternative solutions or features you've considered. --> | ||
|
||
### Additional context | ||
|
||
<!-- Add any other context or screenshots about the feature request here. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
<!-- | ||
For Work In Progress Pull Requests, please use the Draft PR feature, | ||
see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details. | ||
For a timely review/response, please avoid force-pushing additional | ||
commits if your PR already received reviews or comments. | ||
Before submitting a Pull Request, please ensure you've done the following: | ||
- 📖 Read the Open Sauced Contributing Guide: https://github.com/open-sauced/open-sauced/blob/HEAD/CONTRIBUTING.md#create-a-pull-request. | ||
- 📖 Read the Open Sauced Code of Conduct: https://github.com/open-sauced/open-sauced/blob/HEAD/CODE_OF_CONDUCT.md. | ||
- 👷♀️ Create small PRs. In most cases, this will be possible. | ||
- ✅ Provide tests for your changes. | ||
- 📝 Use descriptive commit messages. | ||
- 📗 Update any related documentation and include any relevant screenshots. | ||
--> | ||
|
||
## What type of PR is this? (check all applicable) | ||
|
||
- [ ] ♻️ Refactor | ||
- [ ] ✨ Feature | ||
- [ ] 🐛 Bug Fix | ||
- [ ] 👷 Optimization | ||
- [ ] 📝 Documentation Update | ||
- [ ] 🔖 Release | ||
- [ ] 🚩 Other | ||
|
||
## Description | ||
|
||
<!-- Please do not leave this blank --> | ||
|
||
This PR [adds/removes/fixes/replaces] this [feature/bug/etc]. | ||
|
||
## Related Tickets & Documents | ||
<!-- | ||
Please use this format link issue numbers: Fixes #123 | ||
https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword | ||
--> | ||
|
||
## Mobile & Desktop Screenshots/Recordings | ||
|
||
<!-- Visual changes require screenshots --> | ||
|
||
|
||
## Added tests? | ||
|
||
- [ ] 👍 yes | ||
- [ ] 🙅 no, because they aren't needed | ||
- [ ] 🙋 no, because I need help | ||
|
||
## Added to documentation? | ||
|
||
- [ ] 📜 readme | ||
- [ ] 📜 contributing.md | ||
- [ ] 📓 docs | ||
- [ ] 📕 storybook | ||
- [ ] 🙅 no documentation needed | ||
|
||
## [optional] Are there any post-deployment tasks we need to perform? | ||
|
||
|
||
|
||
## [optional] What gif best describes this PR or how it makes you feel? | ||
|
||
|
||
|
||
<!-- note: PRs with deletes sections will be marked invalid --> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers 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, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [email protected]. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see | ||
https://www.contributor-covenant.org/faq |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
# CONTRIBUTING | ||
|
||
Contributions are always welcome, no matter how large or small. Before contributing, | ||
please read the [code of conduct](CODE_OF_CONDUCT.md). | ||
|
||
Some thoughts to help you contribute to this project | ||
|
||
## Recommended Communication Style | ||
|
||
1. Always leave screenshots for visuals changes | ||
1. Always leave a detailed description in the Pull Request. Leave nothing ambiguous for the reviewer. | ||
1. Always review your code first. Do this by leaving comments in your coding noting questions, or interesting things for the reviewer. | ||
1. Always communicate. Whether it is in the issue or the pull request, keeping the lines of communication helps everyone around you. | ||
|
||
## Setup (forks are preferred). | ||
|
||
```sh | ||
$ git clone https://github.com/<your-name>/open-sauced | ||
$ cd open-sauced | ||
$ npm install | ||
``` | ||
|
||
## Building | ||
|
||
```sh | ||
$ npm run build | ||
``` | ||
|
||
## Testing | ||
For running the test suite, use the following command. Since the tests run in watch mode by default, some users may encounter errors about too many files being open. In this case, it may be beneficial to [install watchman](https://facebook.github.io/watchman/docs/install.html). | ||
```sh | ||
# the tests will run in watch mode by default | ||
$ npm run test | ||
``` | ||
|
||
## Pull Requests | ||
|
||
### _We actively welcome your pull requests, however linking your work to an existing issue is preferred._ | ||
|
||
1. Fork the repo and create your branch from `main`. | ||
1. Name your branch something that is descriptive to the work you are doing. i.e. adds-new-thing or fixes-mobile | ||
1. If you've added code that should be tested, add tests. | ||
1. If you've changed APIs, update the documentation. | ||
1. If you make visual changes, screenshots are required. | ||
1. Ensure the test suite passes. | ||
1. Make sure you address any lint warnings. | ||
1. If you make the existing code better, please let us know in your PR description. | ||
1. A PR description and title are required. The title is required to begin with: "feat:" or "fix:" | ||
1. [Link to an issue](https://help.github.com/en/github/writing-on-github/autolinked-references-and-urls) in the project. Unsolicited code is welcomed, but an issue is required for announce your intentions. PR's without a linked issue will be marked invalid and closed. | ||
|
||
*note for maintainers: All pull requests need a label to assist automation. See the [template](https://github.com/open-sauced/open-sauced/blob/HEAD/.github/release-drafter.yml) to guide which labels to use.* | ||
|
||
### PR Validation | ||
Examples for valid PR titles: | ||
|
||
- fix: Correct typo. | ||
- feat: Add support for Node 12. | ||
- refactor!: Drop support for Node 6. | ||
|
||
_Note that since PR titles only have a single line, you have to use the ! syntax for breaking changes._ | ||
|
||
See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for more examples. | ||
|
||
### Work in progress | ||
GitHub has support for draft pull requests, which will disable the merge button until the PR is marked as ready for merge. | ||
|
||
## Issues | ||
|
||
If you plan to contribute a change based on an open issue, please assign yourself by commenting on the following word `.take`. Issues that are not assigned are assumed open, and to avoid conflicts, please assign yourself before beginning work on any issues. | ||
|
||
If you would like to contribute to the project for the first time, please consider joining checking the [bug](https://github.com/open-sauced/open-sauced/issues?q=is%3Aissue+is%3Aopen+label%3A%22%F0%9F%90%9B+bug%22) or [good first issue](https://github.com/open-sauced/open-sauced/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) labels. | ||
|
||
Also, all questions are welcomed. | ||
|
||
### Triage Team | ||
|
||
The Triage team is inspired by [expressjs/express](https://github.com/expressjs/express/blob/HEAD/Triager-Guide.md). This team exists to create a path for making contributions to this project and open source. All Triage Team members are expected to follow this guide: [TRIAGE_GUIDE.md](TRIAGE_GUIDE.md) | ||
|
||
> **There are no minimum requirements to become a member of the Triage Team.** | ||
For those interested in getting involved in the project or just open source in general, please request an invite to the Triage Team in [this discussion.](https://github.com/open-sauced/open-sauced/discussions/638) | ||
|
||
## Funding | ||
Open Sauced is a part of GitHub Sponsors. If you would like to contribute, please note the [sponsor page](https://github.com/sponsors/open-sauced) for details on how funds are distributed. If you have made any contributions to the projectd directly or indirectly, please consider adding your profile to the [funding.yml](https://github.com/open-sauced/open-sauced/blob/main/.github/funding.yml). | ||
|
||
## Community | ||
|
||
Do you have questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P). | ||
|
||
## Coding Tips | ||
- Ask questions if you are stuck. | ||
- Use [CSS variables](https://github.com/open-sauced/open-sauced/blob/HEAD/src/styles/variables.js) | ||
- Always use [rel="noreferrer" on all target="_blank" links](https://web.dev/external-anchors-use-rel-noopener/). | ||
|
||
## License | ||
|
||
By contributing to the Open Sauced project, you agree that your contributions will be licensed | ||
under its [MIT license](LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
github: [open-sauced, filiptronicek, ajcwebdev] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# GitHub Security Policy | ||
|
||
GitHub's [Bug Bounty program](https://bounty.github.com) rewards researchers for discovering security vulnerabilities in a number of repositories. The full list of projects that are eligible for rewards are [available on our Bug Bounty site](https://bounty.github.com/#scope). | ||
|
||
If the repository is eligible for rewards, you can submit a report via [HackerOne](https://hackerone.com/github). You can find more useful information in our [rules](https://bounty.github.com/#rules) and [FAQ](https://bounty.github.com/#faqs). | ||
|
||
For repositories not covered by the Bug Bounty program, please open an issue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Open Sauced Support | ||
|
||
If you're looking for support for Open Sauced there are a lot of options, check out: | ||
|
||
* GitHub Discussions — [Open Sauced Discussions](https://github.com/open-sauced/open-sauced/discussions) | ||
* Developer Documentation — [Open Sauced Documentation](https://docs.opensauced.pizza) | ||
* DEV — [The Open Sauced DEV](https://dev.to/opensauced) | ||
* Chat — [Join the Open Sauced Discord](https://discord.com/invite/U2peSNf23P) | ||
|
||
On GitHub Discuss and in the Discord, there are a bunch of helpful community members that should be willing to point you in the right direction. |