about_yml 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bed41d12e9955fe24050b2408d21b9eac408af4
-  data.tar.gz: fc02acb545c06d36a03f96d144506ae475779b78
+  metadata.gz: 4b4a9e428300698f728655e188e34849da008f6d
+  data.tar.gz: 04b409c43c3e59cce0a990cfe73ec8f55d56d969
 SHA512:
-  metadata.gz: 239b7860d4051f4c01bc46885f3f3a9621252d925c8b9be3044defc3655b9e0e68504f7731706a5f828c05de148d29fd12ca465aeee203a5a9b035dce5e46b19
-  data.tar.gz: 4db01b2225d983f7425ec7e6c8526b50affc6fc0d53257eeb4b1fc4649ce1fb40258634cfa491d39cc3c201d0833a222a8ade9095369d4d5da73d97a1d7c75ac
+  metadata.gz: a506c911cd0eee21f983dfb2b8fadf1df6fd75d6537ca369fa73a3e706eee25f755dc5f90e2d5d7217310dd40fea8d18b402187b701d64897e023fb12c82f728
+  data.tar.gz: 8c93f32818ed4e98f0d470a34d404b7732303feab127b7b656b6f36c7e124647a4d9eb7d8c09352df0cffbe59a34d88280f889591827fc95b129d7079db50b09

data/CONTRIBUTING.md

@@ -1,8 +1,17 @@
 ## Welcome!
 
-We're so glad you're thinking about contributing to an 18F open source project! If you're unsure or afraid of anything, just ask or submit the issue or pull request anyways. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contribution, and don't want a wall of rules to get in the way of that.
+We're so glad you're thinking about contributing to an 18F open source project!
+If you're unsure or afraid of anything, just ask or submit the issue or pull
+request anyways. The worst that can happen is that you'll be politely asked to
+change something. We appreciate any sort of contribution, and don't want a wall
+of rules to get in the way of that.
 
-Before contributing, we encourage you to read our CONTRIBUTING policy (you are here), our LICENSE, and our README, all of which should be in this repository. If you have any questions, or want to read more about our underlying policies, you can consult the 18F Open Source Policy GitHub repository at https://github.com/18f/open-source-policy, or just shoot us an email/official government letterhead note to [18f@gsa.gov](mailto:18f@gsa.gov).
+Before contributing, we encourage you to read our CONTRIBUTING policy (you are
+here), our LICENSE, and our README, all of which should be in this repository.
+If you have any questions, or want to read more about our underlying policies,
+you can consult the 18F Open Source Policy GitHub repository at
+https://github.com/18f/open-source-policy, or just shoot us an email/official
+government letterhead note to [18f@gsa.gov](mailto:18f@gsa.gov).
 
 ## Public domain
 
@@ -13,3 +22,64 @@ the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/pub
 All contributions to this project will be released under the CC0
 dedication. By submitting a pull request, you are agreeing to comply
 with this waiver of copyright interest.
+
+## Starting work on an issue
+
+Issues that are marked with the `ready` label are ripe for the picking!  Simply
+assign yourself to the issue to and change its label to `in progress` to
+indicate that you are working on it.
+
+If the issue involves writing code or producing some other change that will
+result in a pull request, begin by creating yourself a branch with a short
+descriptive name of the work that includes the issue number at the end, e.g.,
+`document-pr-process-#36`.
+
+**Note:** If you are not a part of the 18F Team, please fork the repository
+first and then create a branch for yourself with the same convention.
+
+Once your local branch is created, simply push it remotely and this will
+assign the issue to you and move it to be `in progress` automatically.
+
+## Submitting a pull request and completing work
+
+When you are satisfied with your work and ready to submit it to be completed,
+please submit a pull request for review.  If you haven't already, please
+follow the instructions above and create a branch for yourself first.  Prior
+to submitting the pull request, please make note of the following:
+
+1. Code changes should be accompanied by tests.
+2. Please run the tests (`$ ./go test`) to make sure there are no regressions.
+
+Once everything is ready to go, [submit your pull request](https://help.github.com/articles/using-pull-requests/)!
+When creating a pull request please be sure to reference the issue number it
+is associated with, preferably in the title.
+
+If you are working in a branch off of the 18F/about_yml repo directly, you can
+reference the issue like this:
+`Closes #36: Short sentence describing the pull request`
+
+If you are working in a forked copy of the repo, please reference the issue
+like this:
+`Closes 18F/about_yml#36:  Short sentence describing the pull request`
+
+In both cases, please include a descriptive summary of the change in the body
+of the pull request as that will help greatly in reviewing the change and
+understanding what should be taking place inside of it.
+
+By referencing the issue in the pull request as noted above, this will
+automatically update the issue with a `needs review` label and notify the
+collaborators on the project that something is ready for a review.  One of us
+will take a look as soon as we can and initiate the review process, provide
+feedback as necessary, and ultimately merge the change.
+
+Once the code is merged, the branch will be deleted and the `in review`
+label will be removed.  The issue will be automatically updated again to be
+marked as Done and Closed.
+
+## Performing a review of a pull request
+
+If you are performing a review of a pull request please add the `in review`
+label to the pull request and be sure keep the `needs review` label
+associated with it.  This will help keep our Waffle board up-to-date and
+reflect that the pull request is being actively reviewed.  Also, please
+assign yourself so others know who the primary reviewer is.

data/README.md

@@ -53,6 +53,19 @@ schema. To check your project's `.about.yml` file:
 $ about_yml_validate MY-PROJECT/.about.yml
 ```
 
+Alternatively, you can add the following to your `Rakefile` to tie
+`.about.yml` validation into your build process (this assumes that `Rakefile`
+and `.about.yml` are both in the top-level project directory):
+
+```ruby
+# Development-only tasks
+begin
+  require 'about_yml/tasks/check_about_yml'
+  task test: :run_about_yml_check
+rescue LoadError
+end
+```
+
 ### `about_yml_scrape`
 
 This program checks for an `.about.yml` file in every GitHub repository

data/lib/about_yml/schema.json

@@ -214,8 +214,16 @@
                 "text": {
                     "type": "string",
                     "description": "Anchor text for the link"
+                },
+                "category": {
+                    "type": "string",
+                    "description": "Type of the link",
+                    "enum": ["api", "process", "related"]
                 }
-            }
+            },
+            "required": [
+              "url"
+            ]
         },
         "contact": {
             "type": "object",

data/lib/about_yml/tasks/check_about_yml.rb

@@ -0,0 +1,20 @@
+require 'about_yml'
+require 'safe_yaml'
+
+desc 'Check your .about.yml file'
+task :run_about_yml_check do
+  project_dir = Rake.original_dir
+  about_file = File.join project_dir, '.about.yml'
+  unless File.exist? about_file
+    $stderr.puts "No .about.yml file found in #{project_dir}"
+    exit 1
+  end
+
+  about_data = SafeYAML.load_file about_file, safe: true
+  errors = ::AboutYml::AboutFile.validate_single_file about_data
+  unless errors.empty?
+    $stderr.puts(".about.yml contains the following validation errors:\n  " +
+      "#{errors.join("\n  ")}")
+    exit 1
+  end
+end

data/lib/about_yml/version.rb

@@ -1,5 +1,5 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
 module AboutYml
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: about_yml
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Mike Bland
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-12 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -163,6 +163,7 @@ files:
 - lib/about_yml/about.rb
 - lib/about_yml/data_faker.rb
 - lib/about_yml/schema.json
+- lib/about_yml/tasks/check_about_yml.rb
 - lib/about_yml/template_generator.rb
 - lib/about_yml/version.rb
 homepage: https://github.com/18F/about_yml