rggen 0.24.0 → 0.25.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/CONTRIBUTING.md +66 -0
  3. data/README.md +6 -2
  4. data/lib/rggen/version.rb +1 -1
  5. metadata +14 -13
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 047c661382bb6d82aad5f9b53f1585ef1d74ddec0c214db705ce89995206c40d
4
- data.tar.gz: 33c9b71866b88141abbea7763e7b68fded4b1813619b5fc63cb6ffac9d0b9b71
3
+ metadata.gz: b52b2a9f17c8ad13e4bb79b2ce15ed67107598a728c4a0e9391e1bfdcbc1e6f8
4
+ data.tar.gz: 179a4a5cc6f93005a0a00dc27a2acdfcf2a5cf2c38f724237fd036e9ea1ff026
5
5
  SHA512:
6
- metadata.gz: 4570c9d46069b2456ca16e42a7537ab0b8cd2852f264e29159ee72e13e9e3af6945ce882bbfa7bcd5860d65b5df2c3c4ef883bf5d1ec6ec7c8c48a95e62dffe5
7
- data.tar.gz: 6acb861778c064e8d133bb73ee195630727036f92150563d757568100e2e60756c75964a4a047375c79b0a30f5fb73851bead56281b379b823fbed53e91ae498
6
+ metadata.gz: fcaa357f4358aed00e9f822c65337947844868443ddf8ada9740e938e9e9f138b6f054eea5fabb737273611b7f67f2f6ca13b2cdda448728d64a5a50106f3633
7
+ data.tar.gz: 23068a492c0dd75a4589260e3b2ec862d533697796331ef2c384ef6b7e97f2afcf3f7d6d05e1a8f2decec82806c96d15ba251ec2b6293aa2c620ee2016920be0
data/CONTRIBUTING.md ADDED
@@ -0,0 +1,66 @@
1
+ # Contributing
2
+
3
+ Your contributions are welcome!
4
+
5
+ ## Bug Report
6
+
7
+ You can submit bug reports on [GitHub Issue Tracker](https://github.com/rggen/rggen/issues).
8
+ Please include information below in your report:
9
+
10
+ * How to reproduce the bug which you found
11
+ * test code
12
+ * command
13
+ * Information about your environment
14
+ * Ruby/RgGen version
15
+ * OS
16
+ * etc.
17
+ * Expected result
18
+
19
+ ## Question
20
+
21
+ Questions are accepted on following channels:
22
+
23
+ * [GitHub Discussions](https://github.com/rggen/rggen/discussions)
24
+ * [GitHub Issue Tracker](https://github.com/rggen/rggen/issues)
25
+ * [Gitter Chat Room](https://gitter.im/rggen/rggen)
26
+
27
+ ## Enhancement Request
28
+
29
+ You can submit your enhancement request on [GitHub Issue Tracker](https://github.com/rggen/rggen/issues).
30
+
31
+ ## Pull Request
32
+
33
+ You can also submit pull requests on [GitHub Issue Tracker](https://github.com/rggen/rggen/pulls)
34
+ to fix the bug which you found or implement enhancements which you want.
35
+
36
+ 1. Fork the repositories which you will change
37
+ 2. Setup your working environment
38
+ * See the next section
39
+ 3. Add your change to the repositories
40
+ * You need to add RSpec exmaples if you add new features
41
+ * You need to make sure all existing RSpec examples pass
42
+ * Invoke `rake spec` on the repositry root
43
+ 4. Make sure all existing RSpec exmaples for other repositories pass
44
+ * Invoke command below on the working directory
45
+ * `./rggen-devtools/bin/run_all_spec.rb`
46
+ 5. Commit your changes and submit a pull request
47
+
48
+ ### Setup Working Environment
49
+
50
+ 1. Create a working directory
51
+ 2. Clone your forked version of the repositories to the working directory
52
+ 3. Clone folloiwng repositories for development tools to the working directory
53
+ * https://github.com/rggen/rggen-devtools
54
+ * https://github.com/rggen/rggen-checkout
55
+ 4. Clone other RgGen's repositories
56
+ * Invoke commnad below on to the working directory
57
+ * `./rggen-devtools/bin/checkout --list ./rggen-checkout/all.yml --dir .`
58
+
59
+ ```
60
+ $ mkdir work
61
+ $ cd work
62
+ $ git clone git@github.com:yourname/your_repository.git
63
+ $ git clone git@github.com:rggen/rggen-devtools.git
64
+ $ git clone git@github.com:rggen/rggen-checkout.git
65
+ $ ./rggen-devtools/bin/checkout.rb --list ./rggen-checkout/all.yml --dir .
66
+ ```
data/README.md CHANGED
@@ -34,7 +34,7 @@ RgGen has following features:
34
34
 
35
35
  ### Ruby
36
36
 
37
- RgGen is written in the [Ruby](https://www.ruby-lang.org/en/about/) programing language and its required version is 2.4 or later. You need to install any of these versions of Ruby before installing RgGen tool. To install Ruby, see [this page](https://www.ruby-lang.org/en/downloads/).
37
+ RgGen is written in the [Ruby](https://www.ruby-lang.org/en/about/) programing language and its required version is 2.5 or later. You need to install any of these versions of Ruby before installing RgGen tool. To install Ruby, see [this page](https://www.ruby-lang.org/en/downloads/).
38
38
 
39
39
  ### Installatin Command
40
40
 
@@ -122,6 +122,10 @@ Then, generated files listed below will be written to `out` directory.
122
122
  * https://github.com/rggen/rggen-sample/blob/master/block_0.md
123
123
  * https://github.com/rggen/rggen-sample/blob/master/block_1.md
124
124
 
125
+ ## Contributing
126
+
127
+ See [Contributing Guide](CONTRIBUTING.md).
128
+
125
129
  ## Contact
126
130
 
127
131
  Feedbacks, bug reports, questions and etc. are wellcome! You can post them by using following ways:
@@ -148,4 +152,4 @@ Copyright © 2019-2021 Taichi Ishitani. RgGen is licensed under the [MIT Lic
148
152
 
149
153
  ## Code of Conduct
150
154
 
151
- Everyone interacting in the RgGen project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rggen/rggen/blob/master/CODE_OF_CONDUCT.md).
155
+ Everyone interacting in the RgGen project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
data/lib/rggen/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module RgGen
4
- VERSION = '0.24.0'
4
+ VERSION = '0.25.0'
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rggen
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.24.0
4
+ version: 0.25.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Taichi Ishitani
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-01-20 00:00:00.000000000 Z
11
+ date: 2021-02-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rggen-core
@@ -16,70 +16,70 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: 0.24.0
19
+ version: 0.25.0
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: 0.24.0
26
+ version: 0.25.0
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: rggen-default-register-map
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - "~>"
32
32
  - !ruby/object:Gem::Version
33
- version: 0.24.0
33
+ version: 0.25.0
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - "~>"
39
39
  - !ruby/object:Gem::Version
40
- version: 0.24.0
40
+ version: 0.25.0
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: rggen-markdown
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
45
  - - "~>"
46
46
  - !ruby/object:Gem::Version
47
- version: 0.20.0
47
+ version: 0.21.0
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - "~>"
53
53
  - !ruby/object:Gem::Version
54
- version: 0.20.0
54
+ version: 0.21.0
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: rggen-spreadsheet-loader
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
59
  - - "~>"
60
60
  - !ruby/object:Gem::Version
61
- version: 0.19.0
61
+ version: 0.20.0
62
62
  type: :runtime
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - "~>"
67
67
  - !ruby/object:Gem::Version
68
- version: 0.19.0
68
+ version: 0.20.0
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: rggen-systemverilog
71
71
  requirement: !ruby/object:Gem::Requirement
72
72
  requirements:
73
73
  - - "~>"
74
74
  - !ruby/object:Gem::Version
75
- version: 0.24.0
75
+ version: 0.25.0
76
76
  type: :runtime
77
77
  prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
80
  - - "~>"
81
81
  - !ruby/object:Gem::Version
82
- version: 0.24.0
82
+ version: 0.25.0
83
83
  - !ruby/object:Gem::Dependency
84
84
  name: bundler
85
85
  requirement: !ruby/object:Gem::Requirement
@@ -105,6 +105,7 @@ extensions: []
105
105
  extra_rdoc_files: []
106
106
  files:
107
107
  - CODE_OF_CONDUCT.md
108
+ - CONTRIBUTING.md
108
109
  - LICENSE
109
110
  - README.md
110
111
  - lib/rggen.rb
@@ -126,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
126
127
  requirements:
127
128
  - - ">="
128
129
  - !ruby/object:Gem::Version
129
- version: '2.4'
130
+ version: '2.5'
130
131
  required_rubygems_version: !ruby/object:Gem::Requirement
131
132
  requirements:
132
133
  - - ">="