hydra-file_characterization 0.3.1 → 1.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.circleci/config.yml +90 -0
- data/.github_changelog_generator +2 -0
- data/.travis.yml +9 -0
- data/CHANGELOG.md +180 -0
- data/CODE_OF_CONDUCT.md +36 -0
- data/CONTRIBUTING.md +70 -22
- data/Gemfile +8 -0
- data/LICENSE +14 -16
- data/README.md +54 -13
- data/Rakefile +6 -0
- data/SUPPORT.md +5 -0
- data/hydra-file_characterization.gemspec +5 -1
- data/lib/hydra/file_characterization/characterizer.rb +44 -24
- data/lib/hydra/file_characterization/characterizers.rb +1 -0
- data/lib/hydra/file_characterization/characterizers/fits.rb +14 -3
- data/lib/hydra/file_characterization/characterizers/fits_servlet.rb +23 -0
- data/lib/hydra/file_characterization/version.rb +1 -1
- data/spec/lib/hydra/file_characterization/characterizer_spec.rb +8 -5
- data/spec/lib/hydra/file_characterization/characterizers/fit_servlet_spec.rb +68 -0
- data/spec/lib/hydra/file_characterization/characterizers/fits_spec.rb +50 -20
- data/spec/lib/hydra/file_characterization_spec.rb +9 -4
- data/spec/spec_helper.rb +5 -2
- metadata +84 -21
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 45f7b237836fc29047cfa5977c7a2644f5789059c846da12316f3ddd7aaa881c
|
|
4
|
+
data.tar.gz: 2c3e32837e473c11ef863993aa87c7874e07cf41504690bda7adc94e5c443341
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3fcd0bee8d7b702a15a207a0ca07f65d7dc05e00ad1d13c537c1072fa12ded45236e2f301d89dd6eea74ec0b9260bc075e5bf340cce81e1f3eb886978ee5cb78
|
|
7
|
+
data.tar.gz: 8edf19cab005e79a44b18edc1e4a6b086c30ac20d4fa251fdf036b95660d13d055cf17f2fa37cac7040314c7790f277bb37e45af2463bcd91d7dc2c6857c1bad
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
---
|
|
2
|
+
version: 2.1
|
|
3
|
+
orbs:
|
|
4
|
+
samvera: samvera/circleci-orb@0
|
|
5
|
+
jobs:
|
|
6
|
+
test:
|
|
7
|
+
parameters:
|
|
8
|
+
ruby_version:
|
|
9
|
+
type: string
|
|
10
|
+
bundler_version:
|
|
11
|
+
type: string
|
|
12
|
+
default: 1.17.3
|
|
13
|
+
rails_version:
|
|
14
|
+
type: string
|
|
15
|
+
executor:
|
|
16
|
+
name: 'samvera/ruby_fcrepo_solr'
|
|
17
|
+
ruby_version: << parameters.ruby_version >>
|
|
18
|
+
environment:
|
|
19
|
+
RAILS_VERSION: << parameters.rails_version >>
|
|
20
|
+
NOKOGIRI_USE_SYSTEM_LIBRARIES: true
|
|
21
|
+
steps:
|
|
22
|
+
- run:
|
|
23
|
+
name: Install the FITS
|
|
24
|
+
command: |
|
|
25
|
+
mkdir ~/fits
|
|
26
|
+
wget "https://github.com/harvard-lts/fits/releases/download/1.4.1/fits-1.4.1.zip"
|
|
27
|
+
unzip -d ~/fits/ "fits-1.4.1.zip"
|
|
28
|
+
chmod a+x ~/fits/fits.sh
|
|
29
|
+
ln -s ~/fits/fits.sh ~/fits/fits
|
|
30
|
+
rm "fits-1.4.1.zip"
|
|
31
|
+
- samvera/cached_checkout
|
|
32
|
+
- samvera/bundle_for_gem:
|
|
33
|
+
ruby_version: << parameters.ruby_version >>
|
|
34
|
+
bundler_version: << parameters.bundler_version >>
|
|
35
|
+
project: hydra-file_characterization
|
|
36
|
+
- run:
|
|
37
|
+
name: Update the PATH env. variable
|
|
38
|
+
command: |
|
|
39
|
+
echo "export PATH=$HOME/fits:$PATH" >> $BASH_ENV
|
|
40
|
+
source $BASH_ENV
|
|
41
|
+
- samvera/parallel_rspec
|
|
42
|
+
|
|
43
|
+
workflows:
|
|
44
|
+
version: 2
|
|
45
|
+
ci:
|
|
46
|
+
jobs:
|
|
47
|
+
- test:
|
|
48
|
+
name: ruby2-7_rails6-0
|
|
49
|
+
ruby_version: 2.7.0
|
|
50
|
+
rails_version: 6.0.2
|
|
51
|
+
- test:
|
|
52
|
+
name: ruby2-6_rails6-0
|
|
53
|
+
ruby_version: 2.6.5
|
|
54
|
+
rails_version: 6.0.2
|
|
55
|
+
- test:
|
|
56
|
+
name: ruby2-5_rails6-0
|
|
57
|
+
ruby_version: 2.5.7
|
|
58
|
+
rails_version: 6.0.2
|
|
59
|
+
- test:
|
|
60
|
+
name: ruby2-7_rails5-2
|
|
61
|
+
ruby_version: 2.7.0
|
|
62
|
+
rails_version: 5.2.4
|
|
63
|
+
- test:
|
|
64
|
+
name: ruby2-6_rails5-2
|
|
65
|
+
ruby_version: 2.6.5
|
|
66
|
+
rails_version: 5.2.4
|
|
67
|
+
- test:
|
|
68
|
+
name: ruby2-5_rails5-2
|
|
69
|
+
ruby_version: 2.5.7
|
|
70
|
+
rails_version: 5.2.4
|
|
71
|
+
- test:
|
|
72
|
+
name: ruby2-4_rails5-2
|
|
73
|
+
ruby_version: 2.4.9
|
|
74
|
+
rails_version: 5.2.4
|
|
75
|
+
- test:
|
|
76
|
+
name: ruby2-7_rails5-1
|
|
77
|
+
ruby_version: 2.7.0
|
|
78
|
+
rails_version: 5.1.7
|
|
79
|
+
- test:
|
|
80
|
+
name: ruby2-6_rails5-1
|
|
81
|
+
ruby_version: 2.6.5
|
|
82
|
+
rails_version: 5.1.7
|
|
83
|
+
- test:
|
|
84
|
+
name: ruby2-5_rails5-1
|
|
85
|
+
ruby_version: 2.5.7
|
|
86
|
+
rails_version: 5.1.7
|
|
87
|
+
- test:
|
|
88
|
+
name: ruby2-4_rails5-1
|
|
89
|
+
ruby_version: 2.4.9
|
|
90
|
+
rails_version: 5.1.7
|
data/.travis.yml
ADDED
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## [1.1.1](https://github.com/samvera/hydra-file_characterization/tree/1.1.1) (2020-06-10)
|
|
4
|
+
|
|
5
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v1.1.0...1.1.1)
|
|
6
|
+
|
|
7
|
+
**Closed issues:**
|
|
8
|
+
|
|
9
|
+
- Add support for Ruby 2.7.z releases [\#44](https://github.com/samvera/hydra-file_characterization/issues/44)
|
|
10
|
+
- Test against Rails release 5.1.7 and Ruby releases 2.6.3, 2.5.5, and 2.4.6 [\#41](https://github.com/samvera/hydra-file_characterization/issues/41)
|
|
11
|
+
- Use CircleCI for continuous integration [\#39](https://github.com/samvera/hydra-file_characterization/issues/39)
|
|
12
|
+
|
|
13
|
+
**Merged pull requests:**
|
|
14
|
+
|
|
15
|
+
- Adding Ruby 2.7.z and Rails 6.y.z releases to the CircleCI build configuration [\#46](https://github.com/samvera/hydra-file_characterization/pull/46) ([jrgriffiniii](https://github.com/jrgriffiniii))
|
|
16
|
+
- Update CircleCI Ruby and Rails versions [\#43](https://github.com/samvera/hydra-file_characterization/pull/43) ([botimer](https://github.com/botimer))
|
|
17
|
+
- Updates the CircleCI configuration to test against Rails release 5.1.7 and Ruby releases 2.6.3, 2.5.5, and 2.4.6 [\#42](https://github.com/samvera/hydra-file_characterization/pull/42) ([jrgriffiniii](https://github.com/jrgriffiniii))
|
|
18
|
+
- Integrates CircleCI for continuous integration [\#40](https://github.com/samvera/hydra-file_characterization/pull/40) ([jrgriffiniii](https://github.com/jrgriffiniii))
|
|
19
|
+
|
|
20
|
+
## [v1.1.0](https://github.com/samvera/hydra-file_characterization/tree/v1.1.0) (2019-05-01)
|
|
21
|
+
|
|
22
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v1.0.0...v1.1.0)
|
|
23
|
+
|
|
24
|
+
**Closed issues:**
|
|
25
|
+
|
|
26
|
+
- Release version 1.0.0 [\#31](https://github.com/samvera/hydra-file_characterization/issues/31)
|
|
27
|
+
|
|
28
|
+
**Merged pull requests:**
|
|
29
|
+
|
|
30
|
+
- Allow usage of FITS Servlet [\#38](https://github.com/samvera/hydra-file_characterization/pull/38) ([little9](https://github.com/little9))
|
|
31
|
+
|
|
32
|
+
## [v1.0.0](https://github.com/samvera/hydra-file_characterization/tree/v1.0.0) (2018-08-21)
|
|
33
|
+
|
|
34
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.3.3...v1.0.0)
|
|
35
|
+
|
|
36
|
+
**Closed issues:**
|
|
37
|
+
|
|
38
|
+
- Remove the Gemnasium badge from README [\#32](https://github.com/samvera/hydra-file_characterization/issues/32)
|
|
39
|
+
- Integrate code coverage analysis [\#30](https://github.com/samvera/hydra-file_characterization/issues/30)
|
|
40
|
+
- Update README badges to point to samvera/hydra-file\_characterization [\#29](https://github.com/samvera/hydra-file_characterization/issues/29)
|
|
41
|
+
- Largest width / height should be used [\#28](https://github.com/samvera/hydra-file_characterization/issues/28)
|
|
42
|
+
- Cut new gem version [\#24](https://github.com/samvera/hydra-file_characterization/issues/24)
|
|
43
|
+
|
|
44
|
+
**Merged pull requests:**
|
|
45
|
+
|
|
46
|
+
- Release version 1.0.0 [\#37](https://github.com/samvera/hydra-file_characterization/pull/37) ([tpendragon](https://github.com/tpendragon))
|
|
47
|
+
- Use CCMWG templates for documentation. [\#36](https://github.com/samvera/hydra-file_characterization/pull/36) ([tpendragon](https://github.com/tpendragon))
|
|
48
|
+
- Resolve \#30; Add coveralls reporting [\#35](https://github.com/samvera/hydra-file_characterization/pull/35) ([botimer](https://github.com/botimer))
|
|
49
|
+
- Resolve \#29; Fix Travis badge links [\#34](https://github.com/samvera/hydra-file_characterization/pull/34) ([botimer](https://github.com/botimer))
|
|
50
|
+
- Resolve \#32; Remove Gemnasium badge [\#33](https://github.com/samvera/hydra-file_characterization/pull/33) ([botimer](https://github.com/botimer))
|
|
51
|
+
- Update travis build matrix [\#27](https://github.com/samvera/hydra-file_characterization/pull/27) ([cbeer](https://github.com/cbeer))
|
|
52
|
+
- Make it clear what contents\_of\_file mean. It wasn't clear to me upon … [\#26](https://github.com/samvera/hydra-file_characterization/pull/26) ([bess](https://github.com/bess))
|
|
53
|
+
|
|
54
|
+
## [v0.3.3](https://github.com/samvera/hydra-file_characterization/tree/v0.3.3) (2015-10-15)
|
|
55
|
+
|
|
56
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.3.2...v0.3.3)
|
|
57
|
+
|
|
58
|
+
**Merged pull requests:**
|
|
59
|
+
|
|
60
|
+
- Add .travis.yml [\#23](https://github.com/samvera/hydra-file_characterization/pull/23) ([jcoyne](https://github.com/jcoyne))
|
|
61
|
+
- Handle non-xml output from FITS [\#22](https://github.com/samvera/hydra-file_characterization/pull/22) ([jcoyne](https://github.com/jcoyne))
|
|
62
|
+
|
|
63
|
+
## [v0.3.2](https://github.com/samvera/hydra-file_characterization/tree/v0.3.2) (2015-08-31)
|
|
64
|
+
|
|
65
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.3.1...v0.3.2)
|
|
66
|
+
|
|
67
|
+
**Merged pull requests:**
|
|
68
|
+
|
|
69
|
+
- Remove non-xml output when Fits is called on a jp2 [\#20](https://github.com/samvera/hydra-file_characterization/pull/20) ([jcoyne](https://github.com/jcoyne))
|
|
70
|
+
- Update to rspec 3 syntax [\#19](https://github.com/samvera/hydra-file_characterization/pull/19) ([jcoyne](https://github.com/jcoyne))
|
|
71
|
+
|
|
72
|
+
## [v0.3.1](https://github.com/samvera/hydra-file_characterization/tree/v0.3.1) (2013-10-25)
|
|
73
|
+
|
|
74
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.3.0...v0.3.1)
|
|
75
|
+
|
|
76
|
+
**Merged pull requests:**
|
|
77
|
+
|
|
78
|
+
- Handle File and string filename passed to characterize. [\#17](https://github.com/samvera/hydra-file_characterization/pull/17) ([jcoyne](https://github.com/jcoyne))
|
|
79
|
+
|
|
80
|
+
## [v0.3.0](https://github.com/samvera/hydra-file_characterization/tree/v0.3.0) (2013-10-23)
|
|
81
|
+
|
|
82
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.9...v0.3.0)
|
|
83
|
+
|
|
84
|
+
**Closed issues:**
|
|
85
|
+
|
|
86
|
+
- There should be away to pass a existing file for characterization [\#14](https://github.com/samvera/hydra-file_characterization/issues/14)
|
|
87
|
+
- Convention over configuration. [\#12](https://github.com/samvera/hydra-file_characterization/issues/12)
|
|
88
|
+
|
|
89
|
+
**Merged pull requests:**
|
|
90
|
+
|
|
91
|
+
- Allow characterize to use an existing file, not just a string. [\#15](https://github.com/samvera/hydra-file_characterization/pull/15) ([jcoyne](https://github.com/jcoyne))
|
|
92
|
+
- Fall back to convention for toolname [\#13](https://github.com/samvera/hydra-file_characterization/pull/13) ([jeremyf](https://github.com/jeremyf))
|
|
93
|
+
|
|
94
|
+
## [v0.2.9](https://github.com/samvera/hydra-file_characterization/tree/v0.2.9) (2013-10-12)
|
|
95
|
+
|
|
96
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.8...v0.2.9)
|
|
97
|
+
|
|
98
|
+
## [v0.2.8](https://github.com/samvera/hydra-file_characterization/tree/v0.2.8) (2013-10-11)
|
|
99
|
+
|
|
100
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.7...v0.2.8)
|
|
101
|
+
|
|
102
|
+
## [v0.2.7](https://github.com/samvera/hydra-file_characterization/tree/v0.2.7) (2013-10-11)
|
|
103
|
+
|
|
104
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.6...v0.2.7)
|
|
105
|
+
|
|
106
|
+
## [v0.2.6](https://github.com/samvera/hydra-file_characterization/tree/v0.2.6) (2013-10-11)
|
|
107
|
+
|
|
108
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.5...v0.2.6)
|
|
109
|
+
|
|
110
|
+
## [v0.2.5](https://github.com/samvera/hydra-file_characterization/tree/v0.2.5) (2013-10-10)
|
|
111
|
+
|
|
112
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.4...v0.2.5)
|
|
113
|
+
|
|
114
|
+
## [v0.2.4](https://github.com/samvera/hydra-file_characterization/tree/v0.2.4) (2013-10-10)
|
|
115
|
+
|
|
116
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.3...v0.2.4)
|
|
117
|
+
|
|
118
|
+
## [v0.2.3](https://github.com/samvera/hydra-file_characterization/tree/v0.2.3) (2013-10-10)
|
|
119
|
+
|
|
120
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.2...v0.2.3)
|
|
121
|
+
|
|
122
|
+
## [v0.2.2](https://github.com/samvera/hydra-file_characterization/tree/v0.2.2) (2013-10-10)
|
|
123
|
+
|
|
124
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.1...v0.2.2)
|
|
125
|
+
|
|
126
|
+
## [v0.2.1](https://github.com/samvera/hydra-file_characterization/tree/v0.2.1) (2013-10-10)
|
|
127
|
+
|
|
128
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.0...v0.2.1)
|
|
129
|
+
|
|
130
|
+
## [v0.2.0](https://github.com/samvera/hydra-file_characterization/tree/v0.2.0) (2013-09-19)
|
|
131
|
+
|
|
132
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.1.3...v0.2.0)
|
|
133
|
+
|
|
134
|
+
## [v0.1.3](https://github.com/samvera/hydra-file_characterization/tree/v0.1.3) (2013-09-19)
|
|
135
|
+
|
|
136
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.1.2...v0.1.3)
|
|
137
|
+
|
|
138
|
+
## [v0.1.2](https://github.com/samvera/hydra-file_characterization/tree/v0.1.2) (2013-09-19)
|
|
139
|
+
|
|
140
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.1.1...v0.1.2)
|
|
141
|
+
|
|
142
|
+
## [v0.1.1](https://github.com/samvera/hydra-file_characterization/tree/v0.1.1) (2013-09-19)
|
|
143
|
+
|
|
144
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.1.0...v0.1.1)
|
|
145
|
+
|
|
146
|
+
## [v0.1.0](https://github.com/samvera/hydra-file_characterization/tree/v0.1.0) (2013-09-19)
|
|
147
|
+
|
|
148
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.0.2...v0.1.0)
|
|
149
|
+
|
|
150
|
+
**Merged pull requests:**
|
|
151
|
+
|
|
152
|
+
- Adding characterizer lookup by tool name [\#11](https://github.com/samvera/hydra-file_characterization/pull/11) ([jeremyf](https://github.com/jeremyf))
|
|
153
|
+
- Renaming Characterizer to Characterizers::Fits [\#10](https://github.com/samvera/hydra-file_characterization/pull/10) ([jeremyf](https://github.com/jeremyf))
|
|
154
|
+
|
|
155
|
+
## [v0.0.2](https://github.com/samvera/hydra-file_characterization/tree/v0.0.2) (2013-09-18)
|
|
156
|
+
|
|
157
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.0.1...v0.0.2)
|
|
158
|
+
|
|
159
|
+
**Closed issues:**
|
|
160
|
+
|
|
161
|
+
- Tests fails as my fits is known as fits.sh [\#5](https://github.com/samvera/hydra-file_characterization/issues/5)
|
|
162
|
+
- File characterization for analysing a compressed file [\#4](https://github.com/samvera/hydra-file_characterization/issues/4)
|
|
163
|
+
- File Characterization for file that confuses fits [\#3](https://github.com/samvera/hydra-file_characterization/issues/3)
|
|
164
|
+
- File Characterization for a missing file on file system [\#2](https://github.com/samvera/hydra-file_characterization/issues/2)
|
|
165
|
+
- File Characterization for file on file system [\#1](https://github.com/samvera/hydra-file_characterization/issues/1)
|
|
166
|
+
|
|
167
|
+
**Merged pull requests:**
|
|
168
|
+
|
|
169
|
+
- Adding next steps to the README [\#9](https://github.com/samvera/hydra-file_characterization/pull/9) ([jeremyf](https://github.com/jeremyf))
|
|
170
|
+
- Adding fits command output [\#8](https://github.com/samvera/hydra-file_characterization/pull/8) ([jeremyf](https://github.com/jeremyf))
|
|
171
|
+
- Verifying characterization of zip file [\#7](https://github.com/samvera/hydra-file_characterization/pull/7) ([jeremyf](https://github.com/jeremyf))
|
|
172
|
+
- Custom exception [\#6](https://github.com/samvera/hydra-file_characterization/pull/6) ([rbalekai](https://github.com/rbalekai))
|
|
173
|
+
|
|
174
|
+
## [v0.0.1](https://github.com/samvera/hydra-file_characterization/tree/v0.0.1) (2013-09-17)
|
|
175
|
+
|
|
176
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/2e61599ffbe12cb13dd1d3f575716507bdaac7d1...v0.0.1)
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
|
data/CODE_OF_CONDUCT.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
The Samvera community is dedicated to providing a welcoming and
|
|
2
|
+
positive experience for all its members, whether they are at a formal
|
|
3
|
+
gathering, in a social setting, or taking part in activities online.
|
|
4
|
+
The Samvera community welcomes participation from people all over the
|
|
5
|
+
world and these members bring with them a wide variety of
|
|
6
|
+
professional, personal and social backgrounds; whatever these may be,
|
|
7
|
+
we treat colleagues with dignity and respect.
|
|
8
|
+
|
|
9
|
+
Community members communicate primarily in English, though for many of
|
|
10
|
+
them this is not their native language. We therefore strive to express
|
|
11
|
+
ourselves simply and clearly remembering that unnecessary use of
|
|
12
|
+
jargon and slang will be a barrier to understanding for many of our
|
|
13
|
+
colleagues. We are sensitive to the fact that the international
|
|
14
|
+
nature of the community means that we span many different social norms
|
|
15
|
+
around language and behaviour and we strive to conduct ourselves,
|
|
16
|
+
online and in person, in ways that are unlikely to cause offence.
|
|
17
|
+
|
|
18
|
+
Samvera conversations are often information-rich and intended to
|
|
19
|
+
generate discussion and debate. We discuss ideas from a standpoint of
|
|
20
|
+
mutual respect and reasoned argument.
|
|
21
|
+
|
|
22
|
+
Community members work together to promote a respectful and safe
|
|
23
|
+
community. In the event that someone’s conduct is causing offence or
|
|
24
|
+
distress, Samvera has a detailed
|
|
25
|
+
[Anti-Harassment Policy and Protocol](https://wiki.duraspace.org/display/samvera/Anti-Harassment+Policy)
|
|
26
|
+
which can be applied to address the problem. The first step in dealing
|
|
27
|
+
with any serious misconduct is to contact a local meeting organizer,
|
|
28
|
+
the
|
|
29
|
+
[Samvera community helpers](https://wiki.duraspace.org/display/samvera/Samvera+Community+Helpers)
|
|
30
|
+
([email](mailto:helpers@samvera.org)), a community member you
|
|
31
|
+
trust, or the
|
|
32
|
+
[Samvera Steering Group](https://wiki.duraspace.org/display/samvera/Samvera+Steering+Group+membership)
|
|
33
|
+
immediately; at Samvera events, these people can be identified by
|
|
34
|
+
distinctive name badges. The
|
|
35
|
+
[Policy and Protocol](https://wiki.duraspace.org/display/samvera/Anti-Harassment+Policy)
|
|
36
|
+
should be consulted for fuller details.
|
data/CONTRIBUTING.md
CHANGED
|
@@ -1,14 +1,24 @@
|
|
|
1
1
|
# How to Contribute
|
|
2
2
|
|
|
3
|
-
We want your help to make
|
|
4
|
-
|
|
3
|
+
We want your help to make the Samvera community great. There are a few guidelines
|
|
4
|
+
that we need contributors to follow so that we can have a chance of
|
|
5
|
+
keeping on top of things.
|
|
5
6
|
|
|
6
|
-
##
|
|
7
|
+
## Code of Conduct
|
|
7
8
|
|
|
8
|
-
|
|
9
|
-
|
|
9
|
+
The Samvera Community is dedicated to providing a welcoming and positive
|
|
10
|
+
experience for all its members, whether they are at a formal gathering, in
|
|
11
|
+
a social setting, or taking part in activities online. Please see our
|
|
12
|
+
[Code of Conduct](CODE_OF_CONDUCT.md) for more information.
|
|
10
13
|
|
|
11
|
-
|
|
14
|
+
## Samvera Community Intellectual Property Licensing and Ownership
|
|
15
|
+
|
|
16
|
+
All code contributors must have an Individual Contributor License Agreement
|
|
17
|
+
(iCLA) on file with the Samvera Steering Group. If the contributor works for
|
|
18
|
+
an institution, the institution must have a Corporate Contributor License
|
|
19
|
+
Agreement (cCLA) on file.
|
|
20
|
+
|
|
21
|
+
https://wiki.duraspace.org/display/samvera/Samvera+Community+Intellectual+Property+Licensing+and+Ownership
|
|
12
22
|
|
|
13
23
|
You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.
|
|
14
24
|
|
|
@@ -16,13 +26,15 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
|
|
|
16
26
|
|
|
17
27
|
* Reporting Issues
|
|
18
28
|
* Making Changes
|
|
29
|
+
* Documenting Code
|
|
30
|
+
* Committing Changes
|
|
19
31
|
* Submitting Changes
|
|
20
|
-
* Merging Changes
|
|
32
|
+
* Reviewing and Merging Changes
|
|
21
33
|
|
|
22
34
|
### Reporting Issues
|
|
23
35
|
|
|
24
36
|
* Make sure you have a [GitHub account](https://github.com/signup/free)
|
|
25
|
-
* Submit a [Github issue](
|
|
37
|
+
* Submit a [Github issue](https://github.com/samvera/hydra-file_characterization/issues/) by:
|
|
26
38
|
* Clearly describing the issue
|
|
27
39
|
* Provide a descriptive summary
|
|
28
40
|
* Explain the expected behavior
|
|
@@ -38,8 +50,24 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
|
|
|
38
50
|
* Then checkout the new branch with `git checkout fix/master/my_contribution`.
|
|
39
51
|
* Please avoid working directly on the `master` branch.
|
|
40
52
|
* You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful
|
|
53
|
+
* Make sure you have added sufficient tests and documentation for your changes.
|
|
54
|
+
* Test functionality with RSpec; Test features / UI with Capybara.
|
|
55
|
+
* Run _all_ the tests to assure nothing else was accidentally broken.
|
|
56
|
+
|
|
57
|
+
### Documenting Code
|
|
58
|
+
|
|
59
|
+
* All new public methods, modules, and classes should include inline documentation in [YARD](http://yardoc.org/).
|
|
60
|
+
* Documentation should seek to answer the question "why does this code exist?"
|
|
61
|
+
* Document private / protected methods as desired.
|
|
62
|
+
* If you are working in a file with no prior documentation, do try to document as you gain understanding of the code.
|
|
63
|
+
* If you don't know exactly what a bit of code does, it is extra likely that it needs to be documented. Take a stab at it and ask for feedback in your pull request. You can use the 'blame' button on GitHub to identify the original developer of the code and @mention them in your comment.
|
|
64
|
+
* This work greatly increases the usability of the code base and supports the on-ramping of new committers.
|
|
65
|
+
* We will all be understanding of one another's time constraints in this area.
|
|
66
|
+
* [Getting started with YARD](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md)
|
|
67
|
+
|
|
68
|
+
### Committing changes
|
|
69
|
+
|
|
41
70
|
* Make commits of logical units.
|
|
42
|
-
* Your commit should include a high level description of your work in HISTORY.textile
|
|
43
71
|
* Check for unnecessary whitespace with `git diff --check` before committing.
|
|
44
72
|
* Make sure your commit messages are [well formed](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
|
|
45
73
|
* If you created an issue, you can close it by including "Closes #issue" in your commit message. See [Github's blog post for more details](https://github.com/blog/1386-closing-issues-via-commit-messages)
|
|
@@ -60,7 +88,9 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
|
|
|
60
88
|
|
|
61
89
|
class PostsController
|
|
62
90
|
def index
|
|
63
|
-
|
|
91
|
+
respond_to do |wants|
|
|
92
|
+
wants.html { render 'index' }
|
|
93
|
+
end
|
|
64
94
|
end
|
|
65
95
|
end
|
|
66
96
|
|
|
@@ -78,36 +108,54 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
|
|
|
78
108
|
|
|
79
109
|
### Submitting Changes
|
|
80
110
|
|
|
81
|
-
[Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
|
|
82
|
-
|
|
83
111
|
* Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub.
|
|
84
112
|
* Make sure your branch is up to date with its parent branch (i.e. master)
|
|
85
113
|
* `git checkout master`
|
|
86
114
|
* `git pull --rebase`
|
|
87
115
|
* `git checkout <your-branch>`
|
|
88
116
|
* `git rebase master`
|
|
89
|
-
* It is
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
117
|
+
* It is a good idea to run your tests again.
|
|
118
|
+
* If you've made more than one commit take a moment to consider whether squashing commits together would help improve their logical grouping.
|
|
119
|
+
* [Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
|
|
120
|
+
* `git rebase --interactive master` ([See Github help](https://help.github.com/articles/interactive-rebase))
|
|
93
121
|
* Squashing your branch's changes into one commit is "good form" and helps the person merging your request to see everything that is going on.
|
|
94
122
|
* Push your changes to a topic branch in your fork of the repository.
|
|
95
123
|
* Submit a pull request from your fork to the project.
|
|
96
124
|
|
|
97
|
-
### Merging Changes
|
|
125
|
+
### Reviewing and Merging Changes
|
|
126
|
+
|
|
127
|
+
We adopted [Github's Pull Request Review](https://help.github.com/articles/about-pull-request-reviews/) for our repositories.
|
|
128
|
+
Common checks that may occur in our repositories:
|
|
129
|
+
|
|
130
|
+
1. Travis CI - where our automated tests are running
|
|
131
|
+
2. Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve.
|
|
132
|
+
|
|
133
|
+
If one or more of the required checks failed (or are incomplete), the code should not be merged (and the UI will not allow it). If all of the checks have passed, then anyone on the project (including the pull request submitter) may merge the code.
|
|
134
|
+
|
|
135
|
+
*Example: Carolyn submits a pull request, Justin reviews the pull request and approves. However, Justin is still waiting on other checks (Travis CI is usually the culprit), so he does not merge the pull request. Eventually, all of the checks pass. At this point, Carolyn or anyone else may merge the pull request.*
|
|
136
|
+
|
|
137
|
+
#### Things to Consider When Reviewing
|
|
138
|
+
|
|
139
|
+
First, the person contributing the code is putting themselves out there. Be mindful of what you say in a review.
|
|
140
|
+
|
|
141
|
+
* Ask clarifying questions
|
|
142
|
+
* State your understanding and expectations
|
|
143
|
+
* Provide example code or alternate solutions, and explain why
|
|
144
|
+
|
|
145
|
+
This is your chance for a mentoring moment of another developer. Take time to give an honest and thorough review of what has changed. Things to consider:
|
|
98
146
|
|
|
99
|
-
* It is considered "poor from" to merge your own request.
|
|
100
|
-
* Please take the time to review the changes and get a sense of what is being changed. Things to consider:
|
|
101
147
|
* Does the commit message explain what is going on?
|
|
102
148
|
* Does the code changes have tests? _Not all changes need new tests, some changes are refactorings_
|
|
149
|
+
* Do new or changed methods, modules, and classes have documentation?
|
|
103
150
|
* Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
|
|
151
|
+
* Does the description of the new/changed specs match your understanding of what the spec is doing?
|
|
104
152
|
* Did the Travis tests complete successfully?
|
|
105
|
-
|
|
106
|
-
|
|
153
|
+
|
|
154
|
+
If you are uncertain, bring other contributors into the conversation by assigning them as a reviewer.
|
|
107
155
|
|
|
108
156
|
# Additional Resources
|
|
109
157
|
|
|
110
158
|
* [General GitHub documentation](http://help.github.com/)
|
|
111
|
-
* [GitHub pull request documentation](
|
|
159
|
+
* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)
|
|
112
160
|
* [Pro Git](http://git-scm.com/book) is both a free and excellent book about Git.
|
|
113
161
|
* [A Git Config for Contributing](http://ndlib.github.io/practices/my-typical-per-project-git-config/)
|