Merge pull request #166 from iamrajiv/readme

docs: Refactor yml and md files

Merging this as it is not code :)

Author: pjotrp

.github/pull_request_template.md

@@ -2,21 +2,23 @@
 was changed. Do not include the issue number in the title. -->
 
 #### References to other Issues or PRs
+
 <!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
 format, e.g. "Fixes #1234". See
 https://github.com/blog/1506-closing-issues-via-pull-requests . Please also
 write a comment on that issue linking back to this pull request once it is
 open. -->
 
-
 #### Brief description of what is fixed or changed
+
 <!-- Description with demonstrating the changes with example(s). Attach screenshort for graph related changes. -->
 
 #### Testcase / documentation
 
 <!-- Make sure you have added the testcases for your code changes and documented (or updated the docs) with examples. -->
 
 #### Other comments
+
 <!-- Any pending work (TODO) -->
 
 <!-- Contribution guide : https://github.com/SciRuby/daru-view/blob/master/CONTRIBUTING.md -->

.github/workflows/test.yml

@@ -2,13 +2,12 @@ name: daru-view test
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   test:
-
     strategy:
       fail-fast: false
       matrix:
@@ -17,20 +16,20 @@ jobs:
     runs-on: ${{ matrix.os }}-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    - name: Install dependencies
-      run: | 
-        gem install bundler
-        gem install rainbow -v '2.2.1'
-        bundle install
-    - name: Run tests
-      run: |
-        bundle exec rspec
-        bundle exec rubocop
-    - name: Push coverage report
-      run:  bundle exec rake coveralls:push
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          gem install rainbow -v '2.2.1'
+          bundle install
+      - name: Run tests
+        run: |
+          bundle exec rspec
+          bundle exec rubocop
+      - name: Push coverage report
+        run: bundle exec rake coveralls:push

.travis.yml

@@ -1,15 +1,14 @@
-language:
-  ruby
+language: ruby
 
 rvm:
   # - '2.0'
   # - '2.1' NOTE: For ruby <2.3,rubocop Offense : adapters/*charts.rb:11:9: C: Style/ModuleFunction: Use module_function instead of extend self.
   # - '2.2' - Not checking because of so many rubocop conflicts with
   # new ruby versions
-  - '2.3.0'
-  - '2.4.0'
-  - '2.5.3'
-  - '2.6.0'
+  - "2.3.0"
+  - "2.4.0"
+  - "2.5.3"
+  - "2.6.0"
 
 script:
   - bundle exec rspec
@@ -20,8 +19,8 @@ after_script:
 
 install:
   - if [ $TRAVIS_RUBY_VERSION == '2.2' ] || [ $TRAVIS_RUBY_VERSION == '2.1' ] || [ $TRAVIS_RUBY_VERSION == '2.0' ];
-      then gem install bundler -v '~> 1.6';
-      else gem install bundler;
-      fi
+    then gem install bundler -v '~> 1.6';
+    else gem install bundler;
+    fi
   - gem install rainbow -v '2.2.1'
   - bundle install

CHANGELOG.md

@@ -3,9 +3,9 @@
 **Fixes:**
 
 - Fixed Rubocop offenses coming from version 0.60 #125 (by @Shekharrajak)
-- Updated README.md and Contribution Guide #129, #131, #133, 
-    #139, #141 (by @Shekharrajak)
-- Removed the duplicate highcharts.css #145 (by @[snpd25](/snpd25)) 
+- Updated README.md and Contribution Guide #129, #131, #133,
+  #139, #141 (by @Shekharrajak)
+- Removed the duplicate highcharts.css #145 (by @[snpd25](/snpd25))
 - [Majaor Fix] Windows installation error fix #147 (by @kojix2 & @Shekharrajak)
 
 ## 0.2.4 (2017-08-29)
@@ -15,25 +15,24 @@
 - Added Highstock feature of HighCharts plotting: #89 (by @Prakriti-nith)
 - Added HighMaps feature of HighCharts plotting: #92 (by @Prakriti-nith)
 - Added Custom Styling CSS feature of HighCharts plotting: #93
-(by @Prakriti-nith)
+  (by @Prakriti-nith)
 - Exporting HighCharts to different formats: #94 (by @Prakriti-nith)
 - Added ChartWrapper feature of GoogleCharts: #95 (by @Prakriti-nith)
 - Import data from google spreadsheet: PR #88 (by @Prakriti-nith)
 - Added ChartEditor feature of GoogleCharts plotting: #96 (by @Prakriti-nith)
 - Multiple Charts having different (or same plotting library)
-in a single row(or in single cell in IRuby notebook): #97 (by @Prakriti-nith)
+  in a single row(or in single cell in IRuby notebook): #97 (by @Prakriti-nith)
 - Different formatters feature of GoogleCharts: #110 (by @Prakriti-nith)
 - Require dependent JS for the plotting libraries
-GoogleCharts/HighCharts/DataTables in Rails application.js file: #115
-(by @Prakriti-nith)
-
+  GoogleCharts/HighCharts/DataTables in Rails application.js file: #115
+  (by @Prakriti-nith)
 
 **Minor Enhancements:**
 
 - Exporting charts in PNG formate for GoogleCharts: #98 (by @Prakriti-nith)
 - Handling Events in GoogleCharts: #100 (by @Prakriti-nith)
 - Added a method to load dependent scripts for multiple adapters: #107
-(by @Prakriti-nith)
+  (by @Prakriti-nith)
 - Rake Task to add new adapter templates: #112 (by @Prakriti-nith)
 - (by @Prakriti-nith)
 - export_html method, generate_html method is implemented and load large set of data piece by piece using datatables adaptor: #104 (by @Prakriti-nith)
@@ -47,26 +46,26 @@ GoogleCharts/HighCharts/DataTables in Rails application.js file: #115
 
 **Note:**
 
-* [GSoC 2018 project](https://github.com/SciRuby/daru-view/wiki/GSoC-2018---Progress-Report)
+- [GSoC 2018 project](https://github.com/SciRuby/daru-view/wiki/GSoC-2018---Progress-Report)
 
 ## 0.1.0 (2017-09-20)
 
 **Features:**
 
 - Generate Plot using [Nyaplot](https://github.com/SciRuby/nyaplot),
-[google_visualr](https://github.com/winston/google_visualr/),
-[lazy_high_charts](https://github.com/michelson/lazy_high_charts) gem with more features.
+  [google_visualr](https://github.com/winston/google_visualr/),
+  [lazy_high_charts](https://github.com/michelson/lazy_high_charts) gem with more features.
 
 - Generate Tables using [Google Charts DataTable](https://developers.google.com/chart/interactive/docs/gallery/table) and [daru-data_tables](https://github.com/Shekharrajak/daru-data_tables) with features like pagination, sorting by column, option to choose number of rows to be displayed.
 
 - Plotting can be done in IRuby notebook as well as any ruby web application
-framework.
+  framework.
 
 - Data can be in Daru::DataFrame, Daru::Vector, array of array data or
-according to the formate described in [Google Charts tool](https://developers.google.com/chart/interactive/docs/gallery), [Highcharts](https://www.highcharts.com/demo).
+  according to the formate described in [Google Charts tool](https://developers.google.com/chart/interactive/docs/gallery), [Highcharts](https://www.highcharts.com/demo).
 
 - User can use all the features already present in google_visualr,
-lazy_high_charts, nayplot by accessing the respective object using
-`#chart` and tables using `#table`.
+  lazy_high_charts, nayplot by accessing the respective object using
+  `#chart` and tables using `#table`.
 
 - The article written about initial features briefly : https://github.com/shekharrajak/daru-view/wiki/All-about-daru-view

CODE_OF_CONDUCT.md

@@ -2,73 +2,131 @@
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+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, caste, color, religion, or sexual
+identity and orientation.
 
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
-Examples of unacceptable behavior by participants include:
+## Our Standards
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+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
 
-## Our Responsibilities
+## Enforcement Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+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.
 
-Project maintainers 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, or to ban temporarily or
-permanently any contributor for other behaviors 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 both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+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 by contacting the project team at shekharstudy@ymail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+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.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+### 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 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations