-
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.
- Loading branch information
0 parents
commit ebf4ba7
Showing
13 changed files
with
398 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,2 @@ | ||
# Auto detect text files and perform LF normalization | ||
* text=auto |
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,71 @@ | ||
# Contributing | ||
|
||
## Request for changes/ Pull Requests | ||
You first need to create a fork of the [github-issue-template](https://github.com/whonion/zig-quadratic-equation/) repository to commit your changes to it. Methods to fork a repository can be found in the [GitHub Documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo). | ||
|
||
Then add your fork as a local project: | ||
|
||
```sh | ||
# Using HTTPS | ||
git clone https://github.com/whonion/zig-quadratic-equation.git | ||
|
||
# Using SSH | ||
git clone [email protected]:whonion/zig-quadratic-equation.git | ||
``` | ||
|
||
> [Which remote URL should be used ?](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories) | ||
Then, go to your local folder | ||
|
||
```sh | ||
cd github-issue-template | ||
``` | ||
|
||
Add git remote controls : | ||
|
||
```sh | ||
# Using HTTPS | ||
git remote add fork https://github.com/YOUR-USERNAME/zig-quadratic-equation.git | ||
git remote add upstream https://github.com/whonion/zig-quadratic-equation.git | ||
|
||
|
||
# Using SSH | ||
git remote add fork [email protected]:YOUR-USERNAME/zig-quadratic-equation.git | ||
git remote add upstream [email protected]/whonion/zig-quadratic-equation.git | ||
``` | ||
|
||
You can now verify that you have your two git remotes: | ||
|
||
```sh | ||
git remote -v | ||
``` | ||
|
||
## Receive remote updates | ||
In view of staying up to date with the central repository : | ||
|
||
```sh | ||
git pull upstream main | ||
``` | ||
|
||
## Choose a base branch | ||
Before starting development, you need to know which branch to base your modifications/additions on. When in doubt, use main. | ||
|
||
| Type of change | | Branches | | ||
| :------------------ |:---------:| ---------------------:| | ||
| Documentation | | `main` | | ||
| Bug fixes | | `main` | | ||
| New features | | `main` | | ||
| New issues models | | `YOUR-USERNAME:patch` | | ||
|
||
```sh | ||
# Switch to the desired branch | ||
git switch main | ||
|
||
# Pull down any upstream changes | ||
git pull | ||
|
||
# Create a new branch to work on | ||
git switch --create patch/1234-name-issue | ||
``` | ||
|
||
Commit your changes, then push the branch to your fork with `git push -u fork` and open a pull request on [the zig-quadratic-equation repository](https://github.com/whonion/zig-quadratic-equation/) following the template provided. |
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,80 @@ | ||
name: "🐛 Bug Report" | ||
description: Create a new ticket for a bug. | ||
title: "🐛 [BUG] - <title>" | ||
labels: [ | ||
"bug" | ||
] | ||
body: | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: "Description" | ||
description: Please enter an explicit description of your issue | ||
placeholder: Short and explicit description of your incident... | ||
validations: | ||
required: true | ||
- type: input | ||
id: reprod-url | ||
attributes: | ||
label: "Reproduction URL" | ||
description: Please enter your GitHub URL to provide a reproduction of the issue | ||
placeholder: ex. https://github.com/USERNAME/REPO-NAME | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reprod | ||
attributes: | ||
label: "Reproduction steps" | ||
description: Please enter an explicit description of your issue | ||
value: | | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
render: bash | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: screenshot | ||
attributes: | ||
label: "Screenshots" | ||
description: If applicable, add screenshots to help explain your problem. | ||
value: | | ||
![DESCRIPTION](LINK.png) | ||
render: bash | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: "Logs" | ||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
render: bash | ||
validations: | ||
required: false | ||
- type: dropdown | ||
id: browsers | ||
attributes: | ||
label: "Browsers" | ||
description: What browsers are you seeing the problem on ? | ||
multiple: true | ||
options: | ||
- Firefox | ||
- Chrome | ||
- Safari | ||
- Microsoft Edge | ||
- Opera | ||
validations: | ||
required: false | ||
- type: dropdown | ||
id: os | ||
attributes: | ||
label: "OS" | ||
description: What is the impacted environment ? | ||
multiple: true | ||
options: | ||
- Windows | ||
- Linux | ||
- Mac | ||
validations: | ||
required: false |
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,63 @@ | ||
name: "💡 Feature Request" | ||
description: Create a new ticket for a new feature request | ||
title: "💡 [REQUEST] - <title>" | ||
labels: [ | ||
"question" | ||
] | ||
body: | ||
- type: input | ||
id: start_date | ||
attributes: | ||
label: "Start Date" | ||
description: Start of development | ||
placeholder: "month/day/year" | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: implementation_pr | ||
attributes: | ||
label: "Implementation PR" | ||
description: Pull request used | ||
placeholder: "#Pull Request ID" | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: reference_issues | ||
attributes: | ||
label: "Reference Issues" | ||
description: Common issues | ||
placeholder: "#Issues IDs" | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: summary | ||
attributes: | ||
label: "Summary" | ||
description: Provide a brief explanation of the feature | ||
placeholder: Describe in a few lines your feature request | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: basic_example | ||
attributes: | ||
label: "Basic Example" | ||
description: Indicate here some basic examples of your feature. | ||
placeholder: A few specific words about your feature request. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: drawbacks | ||
attributes: | ||
label: "Drawbacks" | ||
description: What are the drawbacks/impacts of your feature request ? | ||
placeholder: Identify the drawbacks and impacts while being neutral on your feature request | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: unresolved_question | ||
attributes: | ||
label: "Unresolved questions" | ||
description: What questions still remain unresolved ? | ||
placeholder: Identify any unresolved issues. | ||
validations: | ||
required: false |
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 @@ | ||
blank_issues_enabled: false |
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,18 @@ | ||
## PR Type | ||
What kind of change does this PR introduce? | ||
``` | ||
[ ] Bugfix | ||
[ ] Feature | ||
[ ] Code style update (formatting, local variables) | ||
[ ] Refactoring (no functional changes, no api changes) | ||
[ ] Build related changes | ||
[ ] CI related changes | ||
[ ] Documentation content changes | ||
[ ] Tests | ||
[ ] Other | ||
``` | ||
## What's new? | ||
- | ||
|
||
## Screenshots | ||
N/A |
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,12 @@ | ||
version: 2 | ||
updates: | ||
- package-ecosystem: github-actions | ||
directory: "/" | ||
schedule: | ||
interval: daily | ||
open-pull-requests-limit: 10 | ||
|
||
- package-ecosystem: "gitsubmodule" | ||
directory: "/" | ||
schedule: | ||
interval: "weekly" |
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 @@ | ||
name: Build | ||
|
||
on: [push, pull_request] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v4 |
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 @@ | ||
# Contributor Code of Conduct | ||
|
||
As contributors and maintainers of this project, | ||
and in the interest of fostering an open and welcoming community, | ||
we pledge to respect all people who contribute through reporting issues, | ||
posting feature requests, updating documentation, | ||
submitting pull requests or patches, and other activities. | ||
|
||
We are committed to making participation in this project | ||
a harassment-free experience for everyone, | ||
regardless of level of experience, gender, gender identity and expression, | ||
sexual orientation, disability, personal appearance, | ||
body size, race, ethnicity, age, religion, or nationality. | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery | ||
* Personal attacks | ||
* Trolling or insulting/derogatory comments | ||
* Public or private harassment | ||
* Publishing other's private information, | ||
such as physical or electronic | ||
addresses, without explicit permission | ||
* Other unethical or unprofessional conduct. | ||
|
||
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. | ||
By adopting this Code of Conduct, | ||
project maintainers commit themselves to fairly and consistently | ||
applying these principles to every aspect of managing this project. | ||
Project maintainers who do not follow or enforce the Code of Conduct | ||
may be permanently removed from the project team. | ||
|
||
This code of conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior | ||
may be reported by opening an issue | ||
or contacting one or more of the project maintainers. | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, | ||
available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/) |
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,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 RegEdit | whonion.app | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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,21 @@ | ||
[![Status](https://img.shields.io/badge/Project%20Stage-Development-red.svg)](https://github.com/whonion/all-project-template/blob/main/) [![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Build](https://github.com/whonion/all-project-template/actions/workflows/build.yml/badge.svg)](https://github.com/whonion/all-project-template/actions/workflows/build.yml) | ||
|
||
# All Project Template | ||
|
||
Template for creating new project repositories | ||
|
||
## Prerequisites | ||
|
||
- Linux Ubuntu 20.04 | ||
- Installed dependencies | ||
- Installed another tools | ||
|
||
## Installation | ||
|
||
### Installing on Linux | ||
|
||
### Installing on Windows | ||
|
||
### Installing on MacOS | ||
|
||
## Usage |
Oops, something went wrong.