Skip to content

Commit

Permalink
improvemetns
Browse files Browse the repository at this point in the history
  • Loading branch information
Ruben-Arushanyan committed Sep 27, 2022
1 parent f1b2760 commit b4762b9
Show file tree
Hide file tree
Showing 11 changed files with 303 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: "🐛 Bug"
about: Report a bug or unexpected behavior.
title: ''
labels: bug
assignees: ruben-arushanyan
---

Version:

## Description

A clear and concise description of what the bug is.

## Steps To Reproduce

1.
2.


### Expected vs actual behavior

A clear and concise description of what you expected to happen and what actually happened.

## Additional

Add any other content that might be helpful.

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Ask a question
url: https://github.com/ruben-arushanyan/redux-cool/discussions
about: For questions and answers, see the Discussions section.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: "📃 Documentation"
about: Please file documentation issues here.
title: ''
labels: documentation
assignees: ruben-arushanyan
---

Link:

## Description

A clear and concise description of what the issue is.

## Additional

Add any other content that might be helpful.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: "🆕 Feature"
about: Suggest a new feature for this project.
title: ''
labels: new feature
assignees: ruben-arushanyan
---

## Description

A clear and concise description of what the feature is.

## Additional

Add any other content that might be helpful.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: "🛠️ Imporovement"
about: Suggest an improvement for this project.
title: ''
labels: improvement
assignees: ruben-arushanyan
---

## Description

A clear and concise description of what the improvement is.

## Additional

Add any other content that might be helpful.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/investigation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: "🕵 Investigation"
about: Set an investigation topic.
title: ''
labels: investigation
assignees: ruben-arushanyan
---

## Description

A clear and concise description of what the investigation is.

## Additional

Add any other content that might be helpful.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: "🤌🏼 Proposal"
about: To suggest something.
title: ''
labels: proposal
assignees: ruben-arushanyan
---

## Description

A clear and concise description of what the proposal is.

## Additional

Add any other content that might be helpful.
10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Describe your changes

## Issue ticket number and link

## Checklist
- [ ] Set Reviewers
- [ ] Set Assignees
- [ ] Set Labels

## Additional
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
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
[email protected].
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.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## Contributing

Hi! Thanks for your interest in contributing!

We accept pull requests for bug fixes, improvements, and new features. We'd also love to hear about ideas for new features as issues.

### Submitting an Issue

* 🐛 Open a [bug issue](https://github.com/Ruben-Arushanyan/redux-cool/issues/new?assignees=ruben-arushanyan&labels=bug&template=bug.md&title=) to report a bug or unexpected behavior.
* 📃 Open a [documentation issue](https://github.com/Ruben-Arushanyan/redux-cool/issues/new?assignees=ruben-arushanyan&labels=documentation&template=documentation.md&title=) to report a documentation issue.
* 🆕 Open a [new feature issue](https://github.com/Ruben-Arushanyan/redux-cool/issues/new?assignees=ruben-arushanyan&labels=new+feature&template=feature.md&title=) to suggest an new feature for this project.
* 🛠️ Open an [improvement issue](https://github.com/Ruben-Arushanyan/redux-cool/issues/new?assignees=ruben-arushanyan&labels=improvement&template=improvement.md&title=) to suggest an improvement for this project.
* 🕵 Open an [investigation issue](https://github.com/Ruben-Arushanyan/redux-cool/issues/new?assignees=ruben-arushanyan&labels=investigation&template=investigation.md&title=) to set an investigation topic.
* 🤌🏼 Open an [proposal issue](https://github.com/Ruben-Arushanyan/redux-cool/issues/new?assignees=ruben-arushanyan&labels=proposal&template=proposal.md&title=) to suggest something.

### Git branch naming conventions

- Use issue tracker IDs in branch names.
- Add a short descriptor of the task.
- Use hyphens as separators.

Example
```bash
722-add-billing-module
```
### Submitting a pull request

1. Create a new branch: `git checkout -b 722-my-branch-name`
1. Make your change, add tests, and ensure tests pass
1. Creating a pull request to the `master` branch

### Got a Question or Problem?

Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. Instead, we recommend using [GitHub Discussions](https://github.com/Ruben-Arushanyan/redux-cool/discussions) to ask support-related questions.

## [License](https://github.com/Ruben-Arushanyan/redux-cool/blob/master/LICENSE)

Contributions to this project are released to the public under the [project's open source license](https://github.com/Ruben-Arushanyan/redux-cool/blob/master/LICENSE).

## [Code of Conduct](https://github.com/Ruben-Arushanyan/redux-cool/blob/master/CODE_OF_CONDUCT.md)

This project has adopted the [Contributor Covenant](https://www.contributor-covenant.org) as its Code of Conduct, and we expect project participants to adhere to it. Please read the [full text](https://github.com/Ruben-Arushanyan/redux-cool/blob/master/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.

## Resources

- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [Using Pull Requests](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@ The documentation is divided into several sections:
- [API - reducersCreator](https://redux-cool.js.org/docs/api/reducersCreator)
- [API - actionsCreator](https://redux-cool.js.org/docs/api/actionsCreator)

## [Contributing](https://github.com/ruben-arushanyan/redux-cool/blob/master/CONTRIBUTING.md)

Read our [contributing guide](https://github.com/ruben-arushanyan/redux-cool/blob/master/CONTRIBUTING.md) to learn about our development process.

## [Code of Conduct](https://github.com/ruben-arushanyan/redux-cool/blob/master/CODE_OF_CONDUCT.md)

This project has adopted the [Contributor Covenant](https://www.contributor-covenant.org) as its Code of Conduct, and we expect project participants to adhere to it. Please read the [full text](https://github.com/ruben-arushanyan/redux-cool/blob/master/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.

## Authors

- [Ruben Arushanyan](https://github.com/ruben-arushanyan)
Expand Down

0 comments on commit b4762b9

Please sign in to comment.