Skip to content

Commit 2bdf87b

Browse files
paul58914080paul58914080
authored
Initial commit
0 parents  commit 2bdf87b

File tree

13 files changed

+370
-0
lines changed

13 files changed

+370
-0
lines changed

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @devs-from-matrix/org-maintainers

‎.github/CONTRIBUTING.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# How to contribute
2+
3+
We are really glad you're reading this, because we need volunteer developers to help this project come to fruition.
4+
5+
When contributing to this repository, please first discuss the change you wish to make via issue,
6+
email, slack or any other method with the owners of this repository before making a change.
7+
8+
Please note we have a code of conduct, please follow it in all your interactions with the project.
9+
10+
## Pull request process
11+
12+
- Ensure you have performed a self-review of your changes
13+
- Ensure the new changes generate no new warnings
14+
- Ensure you have added tests that prove the fix is effective or that the feature works
15+
- Ensure new and existing unit tests pass locally with my changes
16+
- Ensure your commit message should follow [conventional commit message guidelines](https://www.conventionalcommits.org/en/v1.0.0/)
17+
18+
## Code of Conduct
19+
20+
### Our pledge
21+
22+
In the interest of fostering an open and welcoming environment, we as
23+
contributors and maintainers pledge to making participation in our project and
24+
our community a harassment-free experience for everyone, regardless of age, body
25+
size, disability, ethnicity, gender identity and expression, level of experience,
26+
nationality, personal appearance, race, religion, or sexual identity and
27+
orientation.
28+
29+
### Our standards
30+
31+
Examples of behavior that contributes to creating a positive environment
32+
include:
33+
34+
* Using welcoming and inclusive language
35+
* Being respectful of differing viewpoints and experiences
36+
* Gracefully accepting constructive criticism
37+
* Focusing on what is best for the community
38+
* Showing empathy towards other community members
39+
40+
Examples of unacceptable behavior by participants include:
41+
42+
* The use of sexualized language or imagery and unwelcome sexual attention or
43+
advances
44+
* Trolling, insulting/derogatory comments, and personal or political attacks
45+
* Public or private harassment
46+
* Publishing others' private information, such as a physical or electronic
47+
address, without explicit permission
48+
* Other conduct which could reasonably be considered inappropriate in a
49+
professional setting
50+
51+
### Our responsibilities
52+
53+
Project maintainers are responsible for clarifying the standards of acceptable
54+
behavior and are expected to take appropriate and fair corrective action in
55+
response to any instances of unacceptable behavior.
56+
57+
Project maintainers have the right and responsibility to remove, edit, or
58+
reject comments, commits, code, wiki edits, issues, and other contributions
59+
that are not aligned to this Code of Conduct, or to ban temporarily or
60+
permanently any contributor for other behaviors that they deem inappropriate,
61+
threatening, offensive, or harmful.
62+
63+
### Scope
64+
65+
This Code of Conduct applies both within project spaces and in public spaces
66+
when an individual is representing the project or its community. Examples of
67+
representing a project or community include using an official project e-mail
68+
address, posting via an official social media account, or acting as an appointed
69+
representative at an online or offline event. Representation of a project may be
70+
further defined and clarified by project maintainers.
71+
72+
### Enforcement
73+
74+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
75+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
76+
complaints will be reviewed and investigated and will result in a response that
77+
is deemed necessary and appropriate to the circumstances. The project team is
78+
obligated to maintain confidentiality with regard to the reporter of an incident.
79+
Further details of specific enforcement policies may be posted separately.
80+
81+
Project maintainers who do not follow or enforce the Code of Conduct in good
82+
faith may face temporary or permanent repercussions as determined by other
83+
members of the project's leadership.
84+

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[Bug]"
5+
labels: ":bug: bug"
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+
**Additional context**
27+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
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: "[New Feature]"
5+
labels: ":rocket: enhancement"
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‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Description
2+
3+
<!-- Description about this pull request -->
4+
5+
Closes : <!-- refer the github issue. Ex: #084-->
6+
7+
# Checklist:
8+
9+
- [ ] My code follows the contribution guidelines of this project
10+
- [ ] I have performed a self-review of my own code
11+
- [ ] My changes generate no new warnings
12+
- [ ] I have added tests that prove my fix is effective or that my feature works
13+
- [ ] New and existing unit tests pass locally with my changes
14+
- [ ] My commits follow [conventional commit message guidelines](https://www.conventionalcommits.org/en/v1.0.0/)

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# IntelliJ project files
2+
.idea
3+
*.iml
4+
out
5+
gen

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Developers from matrix
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‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Title
2+
3+
<!--
4+
this project was generated with https://github.com/devs-from-matrix/basic-template-repository.
5+
-->
6+
7+
## [Documentation](https://devs-from-matrix.github.io/basic-template-repository/)
8+
9+
## How to build ?
10+
11+
<!-- mention the steps for building this project -->
12+
13+
## How to start ?
14+
15+
<!-- mention the steps for starting or serving this project -->
16+
17+
## Contribution guidelines
18+
19+
We are really glad you're reading this, because we need volunteer developers to help this project come to fruition.
20+
21+
Request you to please read our [contribution guidelines](https://devs-from-matrix.github.io/basic-template-repository/#/README?id=contribution-guidelines)

‎docs/.nojekyll‎

Whitespace-only changes.

‎docs/README.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Overview
2+
3+
This project was generated by referring template repository at https://github.com/devs-from-matrix/basic-template-repository.
4+
5+
## Contribution guidelines
6+
7+
We are really glad you're reading this, because we need volunteer developers to help this project come to fruition.
8+
9+
When contributing to this repository, please first discuss the change you wish to make via issue,
10+
email, slack or any other method with the owners of this repository before making a change.
11+
12+
Please note we have a code of conduct, please follow it in all your interactions with the project.
13+
14+
## Pull request process
15+
16+
- Ensure you have performed a self-review of your changes
17+
- Ensure the new changes generate no new warnings
18+
- Ensure you have added tests that prove the fix is effective or that the feature works
19+
- Ensure new and existing unit tests pass locally with my changes
20+
- Ensure your commit message should follow [conventional commit message guidelines](https://www.conventionalcommits.org/en/v1.0.0/)
21+
22+
## Code of Conduct
23+
24+
### Our pledge
25+
26+
In the interest of fostering an open and welcoming environment, we as
27+
contributors and maintainers pledge to making participation in our project and
28+
our community a harassment-free experience for everyone, regardless of age, body
29+
size, disability, ethnicity, gender identity and expression, level of experience,
30+
nationality, personal appearance, race, religion, or sexual identity and
31+
orientation.
32+
33+
### Our standards
34+
35+
Examples of behavior that contributes to creating a positive environment
36+
include:
37+
38+
* Using welcoming and inclusive language
39+
* Being respectful of differing viewpoints and experiences
40+
* Gracefully accepting constructive criticism
41+
* Focusing on what is best for the community
42+
* Showing empathy towards other community members
43+
44+
Examples of unacceptable behavior by participants include:
45+
46+
* The use of sexualized language or imagery and unwelcome sexual attention or
47+
advances
48+
* Trolling, insulting/derogatory comments, and personal or political attacks
49+
* Public or private harassment
50+
* Publishing others' private information, such as a physical or electronic
51+
address, without explicit permission
52+
* Other conduct which could reasonably be considered inappropriate in a
53+
professional setting
54+
55+
### Our responsibilities
56+
57+
Project maintainers are responsible for clarifying the standards of acceptable
58+
behavior and are expected to take appropriate and fair corrective action in
59+
response to any instances of unacceptable behavior.
60+
61+
Project maintainers have the right and responsibility to remove, edit, or
62+
reject comments, commits, code, wiki edits, issues, and other contributions
63+
that are not aligned to this Code of Conduct, or to ban temporarily or
64+
permanently any contributor for other behaviors that they deem inappropriate,
65+
threatening, offensive, or harmful.
66+
67+
### Scope
68+
69+
This Code of Conduct applies both within project spaces and in public spaces
70+
when an individual is representing the project or its community. Examples of
71+
representing a project or community include using an official project e-mail
72+
address, posting via an official social media account, or acting as an appointed
73+
representative at an online or offline event. Representation of a project may be
74+
further defined and clarified by project maintainers.
75+
76+
### Enforcement
77+
78+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
79+
reported by contacting the project team at `[INSERT EMAIL ADDRESS]`. All
80+
complaints will be reviewed and investigated and will result in a response that
81+
is deemed necessary and appropriate to the circumstances. The project team is
82+
obligated to maintain confidentiality with regard to the reporter of an incident.
83+
Further details of specific enforcement policies may be posted separately.
84+
85+
Project maintainers who do not follow or enforce the Code of Conduct in good
86+
faith may face temporary or permanent repercussions as determined by other
87+
members of the project's leadership.

0 commit comments

Comments
 (0)