From cc54f8444c868cdfe446783389067e1aca9e029e Mon Sep 17 00:00:00 2001 From: Chinmay Kabi Date: Fri, 2 Oct 2020 00:17:53 +0530 Subject: [PATCH 1/3] Create CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 129 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 129 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9af1b66 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,129 @@ + +# 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 +chinmay.kabi@live.com. +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. From 1d313899f770dc0e3e0e3904e6ad19a1693ef543 Mon Sep 17 00:00:00 2001 From: Chinmay Kabi Date: Fri, 2 Oct 2020 00:25:04 +0530 Subject: [PATCH 2/3] Create CONTRIBUTING.md --- CONTRIBUTING.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8f528c1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,80 @@ +# Contribution + +If you want to work on an existing issue, then do comment on the issue and I will assign the issue. If you seek to implement something that is not present in the issues, open a new issue and I will assign you to it. + +### Installation +You can view the dart package published [here](https://pub.dev/packages/wp_pivot_flutter). + +Add the following dependencies to pubspec.yaml +``` +dependencies: + wp_pivot_flutter: ^0.0.2 +``` +Now in your dart code, you can use +``` +import 'package:wp_pivot_flutter/wp_pivot_flutter.dart'; +``` + +### Git workflow + +``` +## Step 1: Fork Repository + +## Step 2: Git Set Up & Download +# Clone the repo +$ git clone https://github.com//.git +# Add upstream remote +$ git remote add upstream https://github.com/Chinmay-KB/wp_pivot_flutter.git +# Fetch and merge with upstream/master +$ git fetch upstream +$ git merge upstream/master + +## Step 2: Create and Publish Working Branch +$ git checkout -b //{} +$ git push origin //{} + +## Types: +# wip - Work in Progress; long term work; mainstream changes; +# feat - New Feature; future planned; non-mainstream changes; +# bug - Bug Fixes +# exp - Experimental; random experiemntal features; +``` +### On Task Completion + +``` +## Committing and pushing your work +# Ensure branch +$ git branch +# Fetch and merge with upstream/master +$ git fetch upstream +$ git merge upstream/master +# Add untracked files +$ git add . +# Commit all changes with appropriate commit message and description +$ git commit -m "your-commit-message" -m "your-commit-description" +# Fetch and merge with upstream/master again +$ git fetch upstream +$ git merge upstream/master +# Push changes to your forked repository +$ git push origin //{} + +## Creating the PR using GitHub Website +# Create Pull Request from //{} branch in your forked repository to the master branch in the upstream repository +# After creating PR, add a Reviewer (Any Admin) and yourself as the assignee +# Link Pull Request to appropriate Issue, or Project+Milestone (if no issue created) +# IMPORTANT: Do Not Merge the PR unless specifically asked to by an admin. +``` +### After Pull Request is Merged +``` +# Delete branch from forked repo +$ git branch -d //{} +$ git push --delete origin //{} +# Fetch and merge with upstream/master +$ git checkout master +$ git pull upstream +$ git push origin +``` +### Note +- Always follow [commit message standards](https://chris.beams.io/posts/git-commit/) +- About the [fork-and-branch workflow](https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/) + From 2318d9226d6adef9049e1c2c4efa40d3a7097089 Mon Sep 17 00:00:00 2001 From: Chinmay Kabi Date: Fri, 2 Oct 2020 00:32:12 +0530 Subject: [PATCH 3/3] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 4320eee..5b39f18 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +[![Starware](https://img.shields.io/badge/⭐-Starware-f5a91a?labelColor=black)](https://github.com/zepfietje/starware) + + # wp_pivot_flutter A Flutter package inspirred from Windows Phone Style Pivot Tabs @@ -39,3 +42,8 @@ GlobalKey globalKey = GlobalKey(); } ``` +## Starware + + is Starware. +This means you're free to use the project, as long as you star its GitHub repository. +Your appreciation makes us grow and glow up. ⭐