Skip to content

Commit bbd59aa

Browse files
Utkarsh MishraUtkarsh Mishra
authored andcommitted
Initial Commit
0 parents  commit bbd59aa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+21166
-0
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Feature request
2+
description: Suggest lesson, propose new data-structure and algorithms, discuss new ideas
3+
title: "[FEATURE] <description>"
4+
labels: ["⭐ goal: addition"]
5+
body:
6+
- type: textarea
7+
id: requesttype
8+
attributes:
9+
label: ⭐ Request Type
10+
description: name of the lesson or section you wanted to add.
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: location
15+
attributes:
16+
label: 💻 Location
17+
description: |
18+
Where you think your lesson should be placed(location) so that there will be ease in understanding for new comers.
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: addtionalinfo
23+
attributes:
24+
label: ❌ Additional Info
25+
description: |
26+
If you have any additional information that you think will help the community.
27+
validations:
28+
required: false
29+
- type: markdown
30+
attributes:
31+
value: |
32+
You can also join the Discord community [here](#)
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Feature request
2+
description: propose improvements, adding new code, or any new features
3+
title: "[FEATURE] <description>"
4+
labels: ["⭐ goal: addition"]
5+
body:
6+
- type: textarea
7+
id: summary
8+
attributes:
9+
label: ⭐ Summary
10+
description: A brief summary of what you'd like to see added or improved.
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: location
15+
attributes:
16+
label: 💻 Location
17+
description: |
18+
Describe where or in which section/lesson you want to do improvements.
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: additionalinfo
23+
attributes:
24+
label: ❌ Additional Info
25+
description: |
26+
Any additional information you'd like to provide.
27+
validations:
28+
required: false
29+
- type: markdown
30+
attributes:
31+
value: |
32+
You can also join the Discord community [here](#)

.github/pull_request-template.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!--
2+
(Thanks for sending a pull request!)
3+
-->
4+
5+
<!-- Add the issue number that is fixed by this PR (In the form Fixes #123) -->
6+
7+
Fixes #
8+
9+
#### Short description of what this resolves:
10+
11+
<!--- issue name --->
12+
13+
#### What Changes proposed in this pull request:
14+
15+
-
16+
-
17+
-
18+
19+
#### Checklist
20+
21+
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
22+
23+
- [ ] Added description of change
24+
- [ ] Added file name matches [File name guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md#New-File-Name-guidelines)
25+
- [ ] Added code examples, test must pass
26+
- [ ] Added documentation so that the program is self-explanatory and educational.
27+
- [ ] Relevant documentation/comments is changed or added
28+
- [ ] PR title follows semantic [commit guidelines](https://github.com/Utkarsh1504/ds-algo/CONTRIBUTING.md#Commit-Guidelines)
29+
- [ ] Search previous suggestions before making a new one, as yours may be a duplicate.
30+
- [ ] I acknowledge that all my contributions will be made under the project's license.
31+
32+
Notes: <!-- Please add a one-line description for developers or pull request viewers -->

.github/workflows/gatsby.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Deploy Gatsby Site to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@master
13+
- name: npm install, build, and csv
14+
run: |
15+
npm install
16+
npm run build
17+
npm run csv
18+
- name: Deploy site to gh-pages branch
19+
uses: crazy-max/ghaction-github-pages@v2
20+
with:
21+
target_branch: gh-pages
22+
build_dir: public
23+
env:
24+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Project dependencies
2+
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
3+
node_modules
4+
.cache/
5+
# Build directory
6+
public/
7+
.DS_Store
8+
yarn-error.log

.prettierrc

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

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
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 a maintainer of the [project team members](https://github.com/orgs/dsa-java)
59+
or write a email to 'utkarshmishra73444@gmail.com'. All complaints will be reviewed and investigated and will result
60+
in a response that 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

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Contributing to DS-Algo
2+
3+
First of all, thanks for taking the time to contribute! This project can only grow and live by your countless contributions. To keep this project maintainable, we have developed some guidelines for our contributors.
4+
5+
Please note that by participating, you are expected to uphold the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
6+
7+
## Table of Content
8+
9+
- [Terms](#terms)
10+
- [Lesson](#lesson)
11+
- [Requesting A Lesson](#requesting-a-lesson)
12+
- [Fixing Typos](#fixing-typos)
13+
- [Improving Lesson](#improving-lesson)
14+
- [Our Standards](#our-standards)
15+
- [Communication](#communication)
16+
17+
---
18+
19+
## Lesson
20+
21+
The crux of this site is are the `lesson`. Provided are two examples. Each lesson needs a frontmattter path, order, and title. Generally you should make the path and the file name match for ease of finding it.
22+
23+
- In `Lesson` directory there are various sections. You can start contributing from there.
24+
- Inside each of the sections `lesson` present in the form of markdown. If you wanted to add a new lesson make a new file with `.md` extension and add at the top it.
25+
26+
```yml
27+
28+
---
29+
path: "/pathName"
30+
title: "TitleName"
31+
order: "<Number><CapitalLetter>"
32+
section: "SectionName"
33+
description: "Learn DS-Algo/C++"
34+
---
35+
```
36+
37+
- Modify this according to your contribution and go ahead
38+
- For writing concepts, take a look at the other [lessons]('lesson/Learn-Programming-Language/operator.md') markdown and make sure it is written in a similar way.
39+
40+
## Terms
41+
42+
Here are some terms that we will use in this repo:
43+
44+
- `path` needs a leading slash. This will be slug of the lesson
45+
- `title`- will be the title displayed on the `Table of Contents` and on the page itself
46+
- `order`- the order of which the item should appear in the table of contents. should in `<Number><Capital-letter>` format where the number corresponds to the section itself and the letter corresponds to the order of the lesson inside the section, e.g. 3B means under the section 3 and the order of the lesson will be B(second)
47+
- `section` - the title of the section that the article is in. Only the first lesson for each section will be used.
48+
- `description` - a one-to-three sentence summary of the lesson. used for the meta tag for social shares and SEO. if no description is given, the siteMetadata.description for the site is used.
49+
- `icon` the Font Awesome icon you want for the home page of the site
50+
51+
## Requesting A Lesson
52+
53+
for requesting a lesson simply raise a new issue in the `Issues` section.
54+
55+
- Search for other issues already requesting the lesson.
56+
- If an issue doesn't exist, create an issue naming it `new lesson: <name-of-the-lesson>`
57+
- provide description as mentioned in issue template.
58+
- Please create separate issues for each icon
59+
60+
## Fixing Typos
61+
62+
for fixing typo just make a pull request with your fixes, naming it:
63+
64+
- `fixed typo: <name-of-the-lesson>`
65+
- provide description as mentioned in pull request template.
66+
67+
## Improving lesson
68+
69+
for any improvement in the lesson raise a new issue in the <code>Issues</code> section, Naming it:
70+
71+
- `improvement: <name-of-the-lesson>`
72+
- provide description as mentioned in issue template.
73+
- also one thing to keep in mind, if you wanted to do improvement in the lesson, It should be clear and easy to understand.
74+
75+
## Our Standards
76+
77+
Before you submit your PR, please ensure that they meet the following standard:
78+
79+
- For writing the concept, take a look at the other [lessons]('lesson/Learn-Programming-Language/operator.md') markdown and make sure it is written in a similar way.
80+
- Content inside the lesson should not be copied or plagarized from any other resources, you need to write your own content using your understanding about the concept.
81+
- Code example should not copied from anywhere else, you should set example by your own.
82+
- for adding images and gifs related to the lesson, make sure it is copyright free and not used for commercial purpose. but in case you don't find any image or gif on internet, you can use the [draw.io](draw.io) to make your own images. Images and gif used should be kept in `lesson/images/` directory.
83+
84+
## Communication
85+
86+
We are running a communication channel. You can go here to talk, discuss, and more with the maintainers and other people, too. Here's the invitation: [discord](#)

0 commit comments

Comments
 (0)