Skip to content

Commit ac6923c

Browse files
VisheshBansalVisheshBansal
committed
feat: created a new template with updated README
1 parent ccdfff4 commit ac6923c

File tree

12 files changed

+383
-15
lines changed

12 files changed

+383
-15
lines changed

‎.github/stale.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Number of days of inactivity before an issue becomes stale
2+
daysUntilStale: 30
3+
4+
# Number of days of inactivity before a stale issue is closed
5+
daysUntilClose: 7
6+
7+
# Issues with these labels will never be considered stale
8+
exemptLabels:
9+
- bug
10+
- security
11+
12+
# Label to use when marking an issue as stale
13+
staleLabel: wontfix
14+
15+
# Comment to post when marking an issue as stale. Set to `false` to disable
16+
markComment: >
17+
This issue has been automatically marked as stale because it has not had
18+
recent activity. It will be closed if no further activity occurs. Thank you
19+
for your contributions.
20+
# Comment to post when closing a stale issue. Set to `false` to disable
21+
closeComment: true

‎.github/workflows/commit.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: Lint Commit Messages
2+
on: [pull_request]
3+
4+
jobs:
5+
commitlint:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- uses: actions/checkout@v2
9+
with:
10+
fetch-depth: 0
11+
- uses: wagoid/commitlint-github-action@v2

‎.github/workflows/dependabot_bot_issue.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Create issue on dependabot pr
2+
on:
3+
- pull_request
4+
jobs:
5+
create_commit:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- name: Create issue using REST API
9+
if: contains(github.actor, 'dependabot')
10+
run: |
11+
curl --request POST \
12+
--url https://api.github.com/repos/${{ github.repository }}/issues \
13+
--header 'authorization: Bearer ${{ secrets.GITHUB_TOKEN }}' \
14+
--header 'content-type: application/json' \
15+
--data '{
16+
"title": "Verify for any breaking changes in PR made by ${{ github.actor }}",
17+
"body": "- Kindly check if new dependencies are not introducing any breaking changes.\n- Ref: ${{ github.ref }}",
18+
"labels": ["dependencies", "good first issue"],
19+
"assignees": [""]
20+
}'

‎.github/workflows/linter.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
###########################
3+
###########################
4+
## Linter GitHub Actions ##
5+
###########################
6+
###########################
7+
name: Lint Code Base
8+
9+
#
10+
# Documentation:
11+
# https://help.github.com/en/articles/workflow-syntax-for-github-actions
12+
#
13+
14+
#############################
15+
# Start the job on all push #
16+
#############################
17+
on:
18+
push:
19+
branches: [master]
20+
# Remove the line above to run when pushing to master
21+
pull_request:
22+
branches: [master]
23+
24+
###############
25+
# Set the Job #
26+
###############
27+
jobs:
28+
build:
29+
# Name the Job
30+
name: Lint Code Base
31+
# Set the agent to run on
32+
runs-on: ubuntu-latest
33+
34+
##################
35+
# Load all steps #
36+
##################
37+
steps:
38+
##########################
39+
# Checkout the code base #
40+
##########################
41+
- name: Checkout Code
42+
uses: actions/checkout@v2
43+
with:
44+
# Full git history is needed to get a proper list of changed files within `super-linter`
45+
fetch-depth: 0
46+
47+
################################
48+
# Run Linter against code base #
49+
################################
50+
- name: Lint Code Base
51+
uses: github/super-linter@v3
52+
env:
53+
VALIDATE_ALL_CODEBASE: true
54+
VALIDATE_MARKDOWN: false
55+
DEFAULT_BRANCH: master
56+
VALIDATE_DOCKERFILE: false
57+
VALIDATE_DOCKERFILE_HADOLINT: false
58+
VALIDATE_PYTHON_FLAKE8: false
59+
VALIDATE_BASH: false
60+
VALIDATE_JSCPD: false
61+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Editor
2+
.vscode
3+
.idea
4+
5+
# Environment
6+
.env

‎.hooks/commit-msg‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
#!/bin/sh
3+
commit_message=$(cat "$1" | sed -e 's/^[[:space:]]*//')
4+
matched_str=$(echo "$commit_message" | grep -E "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\([a-z]+\))?: [a-zA-Z0-9 ]+$")
5+
echo "$matched_str"
6+
if [ "$matched_str" != "" ];
7+
then
8+
exit 0
9+
else
10+
echo "Commit rejected due to incorrect commit message format. See commit standards here - https://www.conventionalcommits.org/en/v1.0.0/"
11+
exit 1
12+
fi

‎.hooks/setup.ps1‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Copy-Item ".\commit-msg" -Destination "..\.git\hooks\"
2+
ICACLS "..\.git\hooks\commit-msg" /grant:r "users:(RX)" /C

‎.hooks/setup.sh‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/bin/sh
2+
cp commit-msg ../.git/hooks/commit-msg
3+
chmod +x ../.git/hooks/commit-msg

‎CODE_OF_CONDUCT.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders of **CodeChef-VIT** pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
18+
Examples of behavior that contributes to creating a positive environment
19+
include:
20+
21+
* Using welcoming and inclusive language
22+
* Being respectful of differing viewpoints and experiences
23+
* Gracefully accepting constructive criticism
24+
* Focusing on what is best for the community
25+
* Showing empathy towards other community members
26+
27+
Examples of unacceptable behavior by participants include:
28+
29+
* The use of sexualized language or imagery and unwelcome sexual attention or
30+
advances
31+
* Trolling, insulting/derogatory comments, and personal or political attacks
32+
* Public or private harassment
33+
* Publishing others' private information, such as a physical or electronic
34+
address, without explicit permission
35+
* Sharing critical Pentest findings with public or putting in an issue
36+
* DOS Attack on any of our subdomains (subdomain.codechefvit.com)
37+
* Continous load testing is strictly not allowed
38+
* Other conduct which could reasonably be considered inappropriate in a
39+
professional setting
40+
41+
## Our Responsibilities | Consequences of Unacceptable Behavior
42+
43+
Project maintainers are responsible for clarifying the standards of acceptable
44+
behavior and are expected to take appropriate and fair corrective action in
45+
response to any instances of unacceptable behavior.
46+
47+
Project maintainers have the right and responsibility to remove, edit, or
48+
reject comments, commits, code, wiki edits, issues, and other contributions
49+
that are not aligned to this Code of Conduct, or to ban temporarily or
50+
permanently any contributor for other behaviors that they deem inappropriate,
51+
threatening, offensive, or harmful.
52+
53+
## Scope
54+
55+
This Code of Conduct applies both within project spaces and in public spaces
56+
when an individual is representing the project or its community. Representation of a project may be
57+
further defined and clarified by project maintainers.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported by contacting the project team at `contact@codechefvit.com`. All
63+
complaints will be reviewed and investigated and will result in a response that
64+
is deemed necessary and appropriate to the circumstances. The project team is
65+
obligated to maintain confidentiality with regard to the reporter of an incident.
66+
67+
Project maintainers who do not follow or enforce the Code of Conduct in good
68+
faith may face temporary or permanent repercussions as determined by other
69+
members of the project's leadership.
70+
71+
## Enforcement Guidelines
72+
73+
Community leaders will follow these Community Impact Guidelines in determining
74+
the consequences for any action they deem in violation of this Code of Conduct:
75+
76+
### 1. Correction
77+
78+
**Community Impact**: Use of inappropriate language or other behavior deemed
79+
unprofessional or unwelcome in the community.
80+
81+
**Consequence**: A private, written warning from community leaders, providing
82+
clarity around the nature of the violation and an explanation of why the
83+
behavior was inappropriate. A public apology may be requested.
84+
85+
### 2. Warning
86+
87+
**Community Impact**: A violation through a single incident or series
88+
of actions.
89+
90+
**Consequence**: A warning with consequences for continued behavior. No
91+
interaction with the people involved, including unsolicited interaction with
92+
those enforcing the Code of Conduct, for a specified period of time. This
93+
includes avoiding interactions in community spaces as well as external channels
94+
like social media. Violating these terms may lead to a temporary or
95+
permanent ban.
96+
97+
### 3. Temporary Ban
98+
99+
**Community Impact**: A serious violation of community standards, including
100+
sustained inappropriate behavior.
101+
102+
**Consequence**: A temporary ban from any sort of interaction or public
103+
communication with the community for a specified period of time. No public or
104+
private interaction with the people involved, including unsolicited interaction
105+
with those enforcing the Code of Conduct, is allowed during this period.
106+
Violating these terms may lead to a permanent ban.
107+
108+
### 4. Permanent Ban
109+
110+
**Community Impact**: Demonstrating a pattern of violation of community
111+
standards, including sustained inappropriate behavior, harassment of an
112+
individual, or aggression toward or disparagement of classes of individuals.
113+
114+
**Consequence**: A permanent ban from any sort of public interaction within
115+
the community.
116+
117+
## Attribution
118+
119+
This Code of Conduct is adapted from the **Contributor Covenant**
120+
version 2.1, available at
121+
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
122+
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
https://www.contributor-covenant.org/faq.

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2020 CodeChef-VIT
3+
Copyright (c) 2021 CodeChef-VIT
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)