-
-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3ffce5b
commit 238ad80
Showing
7 changed files
with
290 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# These are supported funding model platforms | ||
|
||
custom: ['https://www.buymeacoffee.com/yasharth'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
- **Issue Description:** | ||
|
||
<Add a brief description about issue or feature you want to add.> | ||
|
||
- **Issue Severity:** | ||
|
||
<High or Medium orLow> | ||
|
||
- **Environment Details:** | ||
|
||
<Add details about the environment where this issue is found.> | ||
|
||
- **Observed Behaviour:** | ||
|
||
<Add details about your observation related to this issue.> | ||
|
||
- **Expected Behaviour:** | ||
|
||
<Add what would like to see once this is an issue is fixed.> | ||
|
||
- **Steps to reproduce issue:** | ||
|
||
<Provide detailed steps to reproduce the issue.> | ||
|
||
- **Snapshots/Videos:** | ||
|
||
<Add snapshots or videos wherever possible.> | ||
|
||
- **Does this issue need immediate attention?** | ||
|
||
<If yes. Please explain in detail> | ||
|
||
- **Are you willing to work on this issue:** | ||
|
||
<Yes or No. If you are working on another issue then the issue will get assigned to someone else for getting work done faster.> | ||
|
||
- **Other information:** | ||
|
||
<Add extra information about this PR here> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
- **Issue Description:** <Add brief description about issue or feature you want to add.> | ||
- **Issue Severity:** <High or Medium orLow> | ||
- **Environment Details:** <Add details about environment where this issue is found.> | ||
- **Observed Behaviour:** <Add details about your observation related to this issue.> | ||
- **Expected Behaviour:** <Add what would like to see once this is issue is fixed.> | ||
- **Steps to reproduce issue:** <Provide detailed steps to reproduce the issue.> | ||
- **Snapshots/Videos:** <Add snapshots or videos wherever possible.> | ||
- **Does this issue need immediate attention?** <If yes. Please explain in detail> | ||
- **Are you willing to work on this issue:** <Yes or No. If you are working on other issue then issue will get assigned to someone else for getting work done faster.> | ||
- **Other information:** <Add extra information about this PR here> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. --> | ||
|
||
**What kind of change does this PR introduce?** | ||
|
||
<!-- E.g. a bugfix, feature, refactoring, etc… --> | ||
|
||
**Did you add tests for your changes?** | ||
|
||
**If relevant, did you update the documentation?** | ||
|
||
**Summary** | ||
|
||
<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? --> | ||
<!-- Try to link to an open issue for more information. --> | ||
|
||
**Does this PR introduce a breaking change?** | ||
|
||
<!-- If this PR introduces a breaking change, please describe the impact and a migration path for existing applications. --> | ||
|
||
**Other information** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our | ||
community a harassment-free experience for everyone, regardless of age, body | ||
size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
identity and expression, level of experience, education, socio-economic status, | ||
nationality, personal appearance, race, religion, or sexual identity | ||
and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, | ||
diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our | ||
community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our mistakes, | ||
and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the | ||
overall community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or | ||
advances of any kind | ||
* Trolling, insulting or derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email | ||
address, without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
|
||
Community leaders have the right and responsibility to remove, edit, or reject | ||
comments, commits, code, wiki edits, issues, and other contributions that are | ||
not aligned to this Code of Conduct, and will communicate reasons for moderation | ||
decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
Examples of representing our community include using an official e-mail address, | ||
posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the community leaders responsible for enforcement at | ||
. | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the | ||
reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining | ||
the consequences for any action they deem in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behavior deemed | ||
unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing | ||
clarity around the nature of the violation and an explanation of why the | ||
behavior was inappropriate. A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series | ||
of actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. No | ||
interaction with the people involved, including unsolicited interaction with | ||
those enforcing the Code of Conduct, for a specified period of time. This | ||
includes avoiding interactions in community spaces as well as external channels | ||
like social media. Violating these terms may lead to a temporary or | ||
permanent ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, including | ||
sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public | ||
communication with the community for a specified period of time. No public or | ||
private interaction with the people involved, including unsolicited interaction | ||
with those enforcing the Code of Conduct, is allowed during this period. | ||
Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community | ||
standards, including sustained inappropriate behavior, harassment of an | ||
individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within | ||
the community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 2.0, available at | ||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. | ||
|
||
Community Impact Guidelines were inspired by [Mozilla's code of conduct | ||
enforcement ladder](https://github.com/mozilla/diversity). | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see the FAQ at | ||
https://www.contributor-covenant.org/faq. Translations are available at | ||
https://www.contributor-covenant.org/translations. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# Contributing | ||
Thank you for your interest in contributing to Shared-Backpack-docs. Regardless of the size of the contribution you make, all contributions are welcome and are appreciated. | ||
|
||
If you are new to contributing to open source, please read the Open Source Guides on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/). | ||
|
||
## Ways to Contribute | ||
If you are ready to start contributing code right away, we have a list of [good first issues](https://github.com/Incentive-Coders/Shared-Backpack-docs/labels/good%20first%20issue) that contain issues with a limited scope. | ||
|
||
## Quicklinks | ||
|
||
* [Our Development Process](#Our-development-process) | ||
* [Issues](#issues) | ||
* [Pull Requests](#pull-requests) | ||
* [Git Flow](#git-flow) | ||
* [Contributing Code](#contributing-code) | ||
* [Community](#community) | ||
|
||
|
||
|
||
### Our Development Process | ||
We utilize GitHub issues and pull requests to keep track of issues and contributions from the community. | ||
|
||
#### Issues | ||
Make sure you are following [issue report guidelines](https://github.com/Incentive-Coders/Shared-Backpack-docs/blog/master/issue-guidelines.md) available here before creating any new issues on Shered-Backpack API project. | ||
|
||
#### Pull Requests | ||
[Pull Request guidelines](https://github.com/Incentive-Coders/Shared-Backpack-docs/blog/master/PR-guidelines.md) is best resource to follow to start working on open issues. | ||
|
||
#### Git Flow | ||
For Shared-Backpack-docs, we utilize the GitFlow branching model. GitFlow is geared towards efficiently tracking development and managing releases. The model makes parallel development efforts easy and safe by isolating new development efforts from completed work. | ||
|
||
The different types of branches we may use are: | ||
* Feature branches (feature/branch-name) | ||
* Release branches (release/1.XX) | ||
* Bug branches (bugfix/branch-name) | ||
* Hotfix branches (hotfix/branch-name) | ||
|
||
Detailed document containing how GitFlow works: https://nvie.com/posts/a-successful-git-branching-model/ | ||
|
||
### Contributing Code | ||
Code contributions to Shared-Backpack-docs come in the form of pull requests. These are done by forking the repo and making changes locally. | ||
|
||
Make sure you have read the [Documentation for Setting up the Project](https://github.com/Incentive-Coders/Shared-Backpack-docs#readme) | ||
|
||
The process of proposing a change to Shared-Backpack-docs can be summarized as: | ||
1. Fork the Shared-Backpack-docs repository and branch off `master`. | ||
2. The repository can be cloned locally using `git clone <forked repo url>`. | ||
3. Make the desired changes to the Shared-Backpack-docs source. | ||
4. Run the website and test your changes. | ||
5. If you've added code that should be tested, write tests. | ||
6. After making changes you can add them to git locally using `git add <file_name>`(to add changes only in a particular file) or `git add .` (to add all changes). | ||
7. After adding the changes you need to commit them using `git commit -m '<commit message>'`(look at the commit guidelines below for commit messages). | ||
8. Once you have successfully commited your changes, you need to push the changes to the forked repo on github using: `git push origin <branch_name>`.(Here branch name must be name of the branch you want to push the changes to.) | ||
9. Now create a pull request to the Shared-Backpack-docs repository from your forked repo. Open an issue regarding the same and link your PR to it. | ||
10. Ensure the test suite passes, either locally or on CI once a PR has been created. | ||
11. Review and address comments on your pull request if requested. | ||
|
||
### Community | ||
The Incentive Coders has a Slack channel where members can assist with support and clarification. Click [here](https://join.slack.com/t/thesharedbackpack/shared_invite/zt-pce62vf4-EGFS3vbmAuJlBCAyAdTEJg) to join our slack channel. | ||
The Incentive Coders has a LinkedIN page. Click [here]( https://www.linkedin.com/company/incentive-coders/) to follow our LinkedIN page. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Security Policy | ||
|
||
## Supported Versions | ||
|
||
Use this section to tell people about which versions of your project are | ||
currently being supported with security updates. | ||
|
||
| Version | Supported | | ||
| ------- | ------------------ | | ||
| 5.1.x | :white_check_mark: | | ||
| 5.0.x | :x: | | ||
| 4.0.x | :white_check_mark: | | ||
| < 4.0 | :x: | | ||
|
||
## Reporting a Vulnerability | ||
|
||
Use this section to tell people how to report a vulnerability. | ||
|
||
Tell them where to go, how often they can expect to get an update on a | ||
reported vulnerability, what to expect if the vulnerability is accepted or | ||
declined, etc. |