forked from wking/fsf-api
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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 wking#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>
- Loading branch information
1 parent
d455634
commit 5dff434
Showing
3 changed files
with
31 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters