Skip to content

Commit 5a88fed

Browse files
DesignrKnightDesignrKnight
committed
Initial commit
0 parents  commit 5a88fed

10 files changed

+339
-0
lines changed

‎.all-contributorsrc

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"files": [
3+
"README.md"
4+
],
5+
"imageSize": 100,
6+
"commit": false,
7+
"contributors": [
8+
{
9+
"login": "dscnitrourkela",
10+
"name": "DSC NIT Rourkela",
11+
"avatar_url": "https://avatars3.githubusercontent.com/u/51153443?v=4",
12+
"profile": "http://dscnitrourkela.org",
13+
"contributions": [
14+
"projectManagement"
15+
]
16+
}
17+
],
18+
"contributorsPerLine": 7,
19+
"projectName": "template",
20+
"projectOwner": "dscnitrourkela",
21+
"repoType": "github",
22+
"repoHost": "https://github.com",
23+
"skipCi": true
24+
}

‎.github/ISSUE_TEMPLATE/bug_report.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
### Your checklist for this pull request
2+
🚨Please review the [guidelines for contributing](../CONTRIBUTING.md) to this repository.
3+
4+
- [ ] Make sure you are requesting to **pull a topic/feature/bugfix branch** (right side). Don't request your default branch!
5+
- [ ] Make sure you are making a pull request against the **default branch** (left side). Also you should start *your branch* off *default branch*.
6+
- [ ] Check the commit's or even all commits' message styles matches our requested structure.
7+
- [ ] Check your code additions will fail neither code linting checks nor unit test.
8+
- [ ] I have added necessary documentation (if appropriate)
9+
10+
### Description
11+
Please describe your pull request.
12+
13+
❤️Thank you!
14+
15+
### Post merge checklist
16+
- [ ] Follow steps from the [guidelines for contributing](../CONTRIBUTING.md) to this repository.
17+
- [ ] If you are a new contributor, ping in the thread and one of the maintainers will add you to all-contributors list.

‎.github/workflows/greet.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: Woofy
2+
on: pull_request_target
3+
jobs:
4+
build:
5+
runs-on: ubuntu-latest
6+
if: github.event.review.state == 'approved'
7+
steps:
8+
- uses: HarishTeens/[email protected]
9+
with:
10+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎CODE_OF_CONDUCT.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

‎CONTRIBUTING.md

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue with the maintainers of this repository before making a change.
4+
5+
Please note we have a code of conduct, please follow it in all your interactions with the project.
6+
7+
## Pull Request Process
8+
9+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
10+
build. Add only relevant files to commit and ignore the rest to keep the repo clean.
11+
2. Update the README.md with details of changes to the interface, this includes new environment
12+
variables, exposed ports, useful file locations and container parameters.
13+
3. You should request review from the maintainers once you submit the Pull Request.
14+
15+
## Instructions
16+
17+
- Git Workflow
18+
19+
```bash
20+
## Step 1: Fork Repository
21+
22+
## Step 2: Git Set Up & Download
23+
# Clone the repo
24+
$ git clone https://github.com/<User-Name>/<Repo-Name>.git
25+
# Add upstream remote
26+
$ git remote add upstream https://github.com/dscnitrourkela/<Repo-Name>.git
27+
# Fetch and merge with upstream/main
28+
$ git fetch upstream
29+
$ git merge upstream/main
30+
31+
## Step 2: Create and Publish Working Branch
32+
$ git checkout -b <type>/<issue|issue-number>/{<additional-fixes>}
33+
$ git push origin <type>/<issue|issue-number>/{<additional-fixes>}
34+
35+
## Types:
36+
# wip - Work in Progress; long term work; mainstream changes;
37+
# feat - New Feature; future planned; non-mainstream changes;
38+
# bug - Bug Fixes
39+
# exp - Experimental; random experiemntal features;
40+
```
41+
42+
- On Task Completion:
43+
44+
```bash
45+
## Committing and pushing your work
46+
# Ensure branch
47+
$ git branch
48+
# Fetch and merge with upstream/main
49+
$ git fetch upstream
50+
$ git merge upstream/main
51+
# Add untracked files
52+
$ git add .
53+
# Commit all changes with appropriate commit message and description
54+
$ git commit -m "your-commit-message" -m "your-commit-description"
55+
# Fetch and merge with upstream/main again
56+
$ git fetch upstream
57+
$ git merge upstream/main
58+
# Push changes to your forked repository
59+
$ git push origin <type>/<issue|issue-number>/{<additional-fixes>}
60+
61+
## Creating the PR using GitHub Website
62+
# Create Pull Request from <type>/<issue|issue-number>/{<additional-fixes>} branch in your forked repository to the main branch in the upstream repository
63+
# After creating PR, add a Reviewer (Any Admin) and yourself as the assignee
64+
# Link Pull Request to appropriate Issue, or Project+Milestone (if no issue created)
65+
# IMPORTANT: Do Not Merge the PR unless specifically asked to by an admin.
66+
```
67+
68+
- After PR Merge
69+
70+
```bash
71+
# Delete branch from forked repo
72+
$ git branch -d <type>/<issue|issue-number>/{<additional-fixes>}
73+
$ git push --delete origin <type>/<issue|issue-number>/{<additional-fixes>}
74+
# Fetch and merge with upstream/main
75+
$ git checkout main
76+
$ git pull upstream
77+
$ git push origin
78+
```
79+
80+
- Always follow [commit message standards](https://chris.beams.io/posts/git-commit/)
81+
- About the [fork-and-branch workflow](https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/)

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 DSC NIT Rourkela
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
[![Starware](https://img.shields.io/badge/Starware-⭐-black?labelColor=f9b00d)](https://github.com/zepfietje/starware)
2+
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
3+
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
4+
<!-- ALL-CONTRIBUTORS-BADGE:END -->
5+
6+
### DSC NIT Rourkela
7+
Project developed and maintained by [DSC NIT Rourkela](https://dscnitrourkela.org/)
8+
![DSC NIT Rourkela Cover Image](./RepoCover.png)
9+
10+
## Contributing
11+
------------
12+
Our Slack Community: [Slack Invite](http://bit.ly/NITRDevs) <br>
13+
14+
`Contributions are welcome 🎉🎉`
15+
16+
Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.
17+
18+
1. **Fork** the repo on GitHub
19+
2. **Clone** the project to your own machine
20+
3. **Commit** changes to your own branch
21+
4. **Push** your work back up to your fork
22+
5. Submit a **Pull request** so that we can review your changes
23+
24+
NOTE 1: Please abide by the [Contributing Guidelines](./CONTRIBUTING.md).
25+
26+
NOTE 2: Please abide by the [Code of Conduct](./CODE_OF_CONDUCT.md).
27+
28+
29+
## Starware
30+
31+
This is Starware.
32+
This means you're free to use the project, as long as you star its GitHub repository.
33+
Your appreciation makes us grow and glow up. ⭐
34+
35+
## Contributors ✨
36+
37+
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
38+
39+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
40+
<!-- prettier-ignore-start -->
41+
<!-- markdownlint-disable -->
42+
<table>
43+
<tr>
44+
<td align="center"><a href="http://dscnitrourkela.org"><img src="https://avatars3.githubusercontent.com/u/51153443?v=4" width="100px;" alt=""/><br /><sub><b>DSC NIT Rourkela</b></sub></a><br /><a href="#projectManagement-dscnitrourkela" title="Project Management">📆</a></td>
45+
</tr>
46+
</table>
47+
48+
<!-- markdownlint-enable -->
49+
<!-- prettier-ignore-end -->
50+
<!-- ALL-CONTRIBUTORS-LIST:END -->
51+
52+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

‎RepoCover.png

76.3 KB
Loading

0 commit comments

Comments
 (0)