Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 1.22 KB
Raw

Contribution guidelines

First of all, thanks for thinking of contributing to this project. 😄

Developing the gem

  1. Fork this repository and clone it and install all the required gem dependencies.

    git clone https://github.com/`your_github_user_id`/networkx.rb.git
cd networkx.rb
gem install bundler
bundle install

  2. Checkout to a different git branch (say, adds-new-feature).

  3. Add code (, test, and YARD documentation).

  4. Run the rspec test-suite.

    # Runs test suite for all files
bundle exec rspec

# Runs test-suite only for a particular file
bundle exec rspec spec/networkx/filename_spec.rb

  5. Run the rubocop for static code quality comments.

    # Runs rubocop test for all files
bundle exec rubocop

# Runs rubocop test only for a particular file
bundle exec rubocop lib/networkx/filename.rb

  6. Send a Pull Request back to this repository. 🎉

Note: YARD Document

You can create YARD documentation

  1. Create Document for doc directory with yard command
  2. Create server via yard server command
  3. open Browser with open http://0.0.0.0:8808 e.t.c.
$ yard
$ yard server
$ open http://0.0.0.0:8808