Update README and CONTRIBUTING docs (#7)

* Update links to point to the SPDX github pages

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>
* Fix broken link in README per https://github.com/wking/fsf-api/pull/23

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>
* Update CONTRIBUTING.md file

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>
* Update copyright date

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>
* Apply suggestions from code review

General clean up of the README file

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
* Remove the gh-pages pull request information - this will soon be done in the CI

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>
* Add (Expat) to the MIT license title per suggestion

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
* Cleanup CONTRIBUTING.md per suggestions

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7e6e28314d07045b29c52cac480f40e31e031deb..5518310c85eefb1781937fb0a18e8f3e87e072bf 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,18 +1,24 @@
-The `master` branch of this repository contains [the pulling script](pull.py) and associated documentation.
-The extracted data is in the `gh-pages` branch.
-To contribute to this project, clone it:
+# Contributing Guide
+
+## Reporting Issues
+
+`fsf-api` has a [project page on GitHub](https://github.com/spdx/fsf-api) where you can [create an issue](https://github.com/spdx/fsf-api/issues/new/choose) to report a bug, make a suggestion, or propose a substantial change or improvement that you might like to make.
+You may also wish to contact the SPDX working group technical team through its mailing list, [spdx-tech@lists.spdx.org](mailto:spdx-tech@lists.spdx.org).
 
-    $ git clone https://github.com/wking/fsf-api.git
+If you would like to work on a fix for any issue, please assign the issue to yourself prior to creating a Pull Request.
 
-And clone another directory to hold `gh-pages`:
+## Submitting Pull Requests
+
+The `master` branch of this repository contains [the pulling script](pull.py) and associated documentation.
+Please review [open pull requests](https://github.com/spdx/fsf-api/pulls) and [active branches](https://github.com/spdx/fsf-api/branches) before committing time to a substantial revision.
+Work along similar lines may already be in progress.
 
-    $ cd fsf-api
-    $ git clone -b gh-pages https://github.com/wking/fsf-api.git data
+To submit a pull request via GitHub, fork the repository, create a topic branch from `master` for your work, and send a pull request when ready.
+If you would prefer to send a patch or grant access to pull from your own Git repository, please contact the project's contributors by email.
 
-After committing a change to `pull.py` in `fsf-api`, change into the data directory, rebuild, and publish:
+## Signing Your Changes
 
-    $ cd data
-    $ make commit
-    $ git push origin gh-pages
+However you choose to contribute, please sign-off each of your commits to certify them under the terms of the [Developer Certificate of Origin](https://developercertificate.org/).
+Git has built-in support for signing off: `git commit -s` signs a current commit, and `git rebase --signoff <revision-range>` retroactively signs a range of past commits.
 
-The content of the `master` branch is available under [the MIT license](LICENSE.md).
+The content of the `master` branch is available under [the MIT (Expat) license](LICENSE.md).

diff --git a/LICENSE.md b/LICENSE.md
index 4b6769017897dedc5d44a75bb7ab0d872dcdfae6..79ce5beed00d358820c3683c23e0c3b0677d3d92 100644 (file)
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -1,4 +1,4 @@
-Copyright (c) 2017 fsf-api contributors
+Copyright (c) 2021 fsf-api contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

diff --git a/README.md b/README.md
index f2de1b3f96250b48e498146fb0f6b9f47573f93b..64138e5f8ce922abee0bf9587522bac0704b8dd7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,26 +10,26 @@ Ideally we'll hand this repository over to the FSF once they're ready to maintai
 ## Endpoints
 
 <a name="licenses.json"></a>
-You can pull an array of identifiers from [https://wking.github.io/fsf-api/licenses.json](https://wking.github.io/fsf-api/licenses.json).
+You can pull an array of identifiers from [https://spdx.github.io/fsf-api/licenses.json](https://spdx.github.io/fsf-api/licenses.json).
 
 <a name="licenses-full.json"></a>
-You can pull an object with all the license data [https://wking.github.io/fsf-api/licenses-full.json](https://wking.github.io/fsf-api/licenses-full.json).
+You can pull an object with all the license data [https://spdx.github.io/fsf-api/licenses-full.json](https://spdx.github.io/fsf-api/licenses-full.json).
 
 You can pull an individual license from a few places:
 
 * <a name="by-fsf-id"></a>
     Using their FSF ID:
 
-        https://wking.github.io/fsf-api/{id}.json
+        https://spdx.github.io/fsf-api/{id}.json
 
-    For example [https://wking.github.io/fsf-api/Expat.json](https://wking.github.io/fsf-api/Expat.json).
+    For example [https://spdx.github.io/fsf-api/Expat.json](https://spdx.github.io/fsf-api/Expat.json).
 
 * <a name="by-non-fsf-id"></a>
     Using a non-FSF ID, according to the mapping between other scheme and the FSF scheme asserted by this API:
 
-        https://wking.github.io/fsf-api/{scheme}/{id}.json
+        https://spdx.github.io/fsf-api/{scheme}/{id}.json
 
-    For example [https://wking.github.io/fsf-api/spdx/MIT.json](https://wking.github.io/fsf-api/spdx/MIT.json).
+    For example [https://spdx.github.io/fsf-api/spdx/MIT.json](https://spdx.github.io/fsf-api/spdx/MIT.json).
     This API currently [attempts](#caveats) to maintain the following mappings:
 
     * `spdx`, using [the SPDX identifiers][spdx-list].
@@ -82,13 +82,18 @@ There are currently some hacks in [the pulling script](pull.py):
 
 Until these hacks are addressed, license IDs and the `tags` and `identifiers` fields should be taken with a grain of salt.
 
+## Credits
+
+The original implementation of the fsf-api was provided by @wking.
+This repository is now being maintained by the SPDX community.
+
 ## Contributing
 
 [Contributions](CONTRIBUTING.md) are welcome!
 
 [automated-matching]: https://github.com/spdx/license-list-XML/issues/418
 [fsf-afl]: https://www.gnu.org/licenses/license-list.html#AcademicFreeLicense
-[fsf-api]: https://lists.spdx.org/pipermail/spdx-legal/2017-October/002281.html
+[fsf-api]: https://lists.spdx.org/g/Spdx-legal/topic/providing_access_to_fsf/22080894
 [fsf-freebsd-fdl]: https://www.gnu.org/licenses/license-list.html#FreeBSDDL
 [fsf-freebsd-gpl]: https://www.gnu.org/licenses/license-list.html#FreeBSD
 [fsf-gplv3]: https://www.gnu.org/licenses/license-list.html#GNUGPLv3