-
Notifications
You must be signed in to change notification settings - Fork 275
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
181 additions
and
20 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
This file was deleted.
Oops, something went wrong.
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,43 @@ | ||
name: 🚀 Feature request | ||
description: Suggest an idea for this project 💡 | ||
title: "Feature: " | ||
labels: [👀 Exploration Pending, 💡 feature] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this feature request! | ||
- type: dropdown | ||
attributes: | ||
multiple: false | ||
label: Type of feature | ||
description: Select the type of feature request, the lowercase should also be the PR prefix. | ||
options: | ||
- "💡 Feature" | ||
- "🐛 Fix" | ||
- "📝 Documentation" | ||
- "🎨 Style" | ||
- "🧑💻 Refactor" | ||
- "🔥 Performance" | ||
- "✅ Test" | ||
- "🤖 Build" | ||
- "🔁 CI" | ||
- "📦 Chore" | ||
- "⏩ Revert" | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Current behavior | ||
description: Is your feature request related to a problem? Please describe. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Suggested solution | ||
description: Describe the solution you'd like. | ||
- type: input | ||
id: context | ||
attributes: | ||
label: Additional context | ||
description: 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,66 @@ | ||
## Description | ||
|
||
<!-- | ||
Please do not leave this blank | ||
This PR [adds/removes/fixes/replaces] the [feature/bug/etc]. | ||
--> | ||
|
||
## What type of PR is this? (check all applicable) | ||
|
||
- [ ] 💡 Feature | ||
- [ ] 🐛 Bug Fix | ||
- [ ] 📝 Documentation Update | ||
- [ ] 🎨 Style | ||
- [ ] 🧑💻 Code Refactor | ||
- [ ] 🔥 Performance Improvements | ||
- [ ] ✅ Test | ||
- [ ] 🤖 Build | ||
- [ ] 🔁 CI | ||
- [ ] 📦 Chore (Release) | ||
- [ ] ⏩ Revert | ||
|
||
## 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 --> | ||
|
||
## Steps to QA | ||
|
||
<!-- | ||
Please provide some steps for the reviewer to test your change. If you have wrote tests, you can mention that here instead. | ||
1. Click a link | ||
2. Do this thing | ||
3. Validate you see the thing working | ||
--> | ||
|
||
## Added to documentation? | ||
|
||
- [ ] 📜 README.md | ||
- [ ] 🙅 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 deleted sections will be marked invalid --> | ||
|
||
<!-- | ||
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: | ||
- 👷♀️ 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. | ||
--> |
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,72 @@ | ||
# CONTRIBUTING | ||
|
||
Contributions are always welcome, no matter how large or small. | ||
|
||
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>/projectx | ||
$ cd projectx | ||
$ yarn install | ||
``` | ||
|
||
## Building | ||
|
||
```sh | ||
$ yarn build | ||
``` | ||
|
||
## 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 | ||
2. Name your branch something that is descriptive to the work you are doing. i.e. adds-new-thing or fixes-mobile | ||
3. Make sure you address any lint warnings. | ||
4. Run yarn format if your unsure | ||
5. If you make the existing code better, please let us know in your PR description. | ||
6. A PR description and title are required. The title is required to begin with: "feat:" or "fix:" | ||
7. [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. | ||
|
||
## Community | ||
|
||
Do you have questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P). | ||
|
||
## License | ||
|
||
ProjectX is open-source under the GNU Affero General Public License Version 3 (AGPLv3) or any later version. |