Skip to content

Commit 0c82ada

Browse files
nbashir97nbashir97
authored
Merge pull request #8 from nbashir97/1.0.x
1.0.x
2 parents a4ff287 + 0bb3c47 commit 0c82ada

14 files changed

Lines changed: 893 additions & 180 deletions

‎.github/CONTRIBUTING.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributing
2+
3+
## Request for changes/ Pull Requests
4+
You first need to create a fork of the [effectsize][effectsize] repository to commit your changes to it. Methods to fork a repository can be found in the [GitHub Documentation][fork].
5+
6+
Then add your fork as a local project:
7+
8+
```sh
9+
# Using HTTPS
10+
git clone https://github.com/nbashir97/effectsize.git
11+
12+
# Using SSH
13+
git clone git@github.com:nbashir97/effectsize
14+
```
15+
16+
> [Which remote URL should be used ?][remote]
17+
18+
Then, go to your local folder
19+
20+
```sh
21+
cd effectsize
22+
```
23+
24+
Add git remote controls :
25+
26+
```sh
27+
# Using HTTPS
28+
git remote add fork https://github.com/YOUR-USERNAME/effectsize.git
29+
git remote add upstream https://github.com/nbashir97/effectsize.git
30+
31+
32+
# Using SSH
33+
git remote add fork git@github.com:YOUR-USERNAME/effectsize.git
34+
git remote add upstream git@github.com/nbashir97/effectsize.git
35+
```
36+
37+
You can now verify that you have your two git remotes:
38+
39+
```sh
40+
git remote -v
41+
```
42+
43+
## Receive remote updates
44+
In view of staying up to date with the central repository :
45+
46+
```sh
47+
git pull upstream master
48+
```
49+
50+
## Choose a base branch
51+
Before starting development, you need to know which branch to base your modifications/additions on. When in doubt, use master.
52+
53+
| Type of change | | Branches |
54+
| :------------------ |:---------:| ---------------------:|
55+
| Documentation | | `master` |
56+
| Bug fixes | | `master` |
57+
| New features | | `master` |
58+
| New issues models | | `YOUR-USERNAME:patch` |
59+
60+
```sh
61+
# Switch to the desired branch
62+
git switch master
63+
64+
# Pull down any upstream changes
65+
git pull
66+
67+
# Create a new branch to work on
68+
git switch --create patch/1234-name-issue
69+
```
70+
71+
Commit your changes, then push the branch to your fork with `git push -u fork` and open a pull request on [the effectsize repository][effectsize] following the template provided.
72+
73+
[effectsize]: https://github.com/nbashir97/effectsize
74+
[fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
75+
[remote]: https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories

‎.github/ISSUE_TEMPLATE/BUG-REPORT.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: "🐛 Bug Report"
2+
description: Create a new ticket for a bug.
3+
title: "🐛 [BUG] - <title>"
4+
labels: [
5+
"bug"
6+
]
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: "Description"
12+
description: Please enter an explicit description of your issue
13+
placeholder: Short and explicit description of your incident...
14+
validations:
15+
required: true
16+
- type: input
17+
id: reprod-url
18+
attributes:
19+
label: "Reproduction URL"
20+
description: Please enter your GitHub URL to provide a reproduction of the issue
21+
placeholder: ex. https://github.com/USERNAME/REPO-NAME
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: reprod
26+
attributes:
27+
label: "Reproduction steps"
28+
description: Please enter an explicit description of your issue
29+
value: |
30+
1. Go to '...'
31+
2. Click on '....'
32+
3. Scroll down to '....'
33+
4. See error
34+
render: bash
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: screenshot
39+
attributes:
40+
label: "Screenshots"
41+
description: If applicable, add screenshots to help explain your problem.
42+
value: |
43+
![DESCRIPTION](LINK.png)
44+
render: bash
45+
validations:
46+
required: false
47+
- type: textarea
48+
id: logs
49+
attributes:
50+
label: "Logs"
51+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
52+
render: bash
53+
validations:
54+
required: false
55+
- type: dropdown
56+
id: os
57+
attributes:
58+
label: "OS"
59+
description: What is the impacted environment ?
60+
multiple: true
61+
options:
62+
- Windows
63+
- Linux
64+
- Mac
65+
validations:
66+
required: false

‎.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: "💡 Feature Request"
2+
description: Create a new ticket for a new feature request
3+
title: "💡 [REQUEST] - <title>"
4+
labels: [
5+
"question"
6+
]
7+
body:
8+
- type: input
9+
id: start_date
10+
attributes:
11+
label: "Start Date"
12+
description: Start of development
13+
placeholder: "month/day/year"
14+
validations:
15+
required: false
16+
- type: textarea
17+
id: implementation_pr
18+
attributes:
19+
label: "Implementation PR"
20+
description: Pull request used
21+
placeholder: "#Pull Request ID"
22+
validations:
23+
required: false
24+
- type: textarea
25+
id: reference_issues
26+
attributes:
27+
label: "Reference Issues"
28+
description: Common issues
29+
placeholder: "#Issues IDs"
30+
validations:
31+
required: false
32+
- type: textarea
33+
id: summary
34+
attributes:
35+
label: "Summary"
36+
description: Provide a brief explanation of the feature
37+
placeholder: Describe in a few lines your feature request
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: basic_example
42+
attributes:
43+
label: "Basic Example"
44+
description: Indicate here some basic examples of your feature.
45+
placeholder: A few specific words about your feature request.
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: drawbacks
50+
attributes:
51+
label: "Drawbacks"
52+
description: What are the drawbacks/impacts of your feature request ?
53+
placeholder: Identify the drawbacks and impacts while being neutral on your feature request
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: unresolved_question
58+
attributes:
59+
label: "Unresolved questions"
60+
description: What questions still remain unresolved ?
61+
placeholder: Identify any unresolved issues.
62+
validations:
63+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/PULL-REQUEST-TEMPLATE.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Pull Request Template
2+
3+
## Description
4+
5+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
6+
7+
Fixes # (issue)
8+
9+
## Type of change
10+
11+
Please delete options that are not relevant.
12+
13+
- [ ] Bug fix (non-breaking change which fixes an issue)
14+
- [ ] New feature (non-breaking change which adds functionality)
15+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16+
- [ ] This change requires a documentation update
17+
18+
## How Has This Been Tested?
19+
20+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
21+
22+
- [ ] Test A
23+
- [ ] Test B
24+
25+
**Test Configuration(s)**:
26+
27+
* Firmware version:
28+
* Hardware:
29+
* Toolchain:
30+
* SDK:
31+
32+
## Checklist:
33+
34+
- [ ] My code follows the style guidelines of this project
35+
- [ ] I have performed a self-review of my own code
36+
- [ ] I have commented my code, particularly in hard-to-understand areas
37+
- [ ] I have made corresponding changes to the documentation
38+
- [ ] My changes generate no new warnings
39+
- [ ] I have added tests that prove my fix is effective or that my feature works
40+
- [ ] New and existing unit tests pass locally with my changes
41+
- [ ] Any dependent changes have been merged and published in downstream modules
42+
- [ ] I have checked my code and corrected any misspellings

0 commit comments

Comments
 (0)