Browse Source

Update some docs

Also the git hooks should be updated
pull/23/head
Steven vanZyl 4 months ago
parent
commit
44c83183c4
4 changed files with 16 additions and 6 deletions
  1. 9
    0
      CONTRIBUTING.md
  2. 1
    0
      scripts/importer/.gitignore
  3. 4
    4
      scripts/importer/README.md
  4. 2
    2
      scripts/importer/Rakefile

+ 9
- 0
CONTRIBUTING.md View File

@@ -4,6 +4,15 @@ Thank you for your interest in contributing to the RCOS Observatory!
4 4
 Please read the following guidelines before opening an issue or
5 5
 pull request.
6 6
 
7
+## Hooks
8
+
9
+There are 2 git hooks as part of this project:
10
+
11
+1. Before every commit `cargo fmt` is run to clean up code.
12
+2. Before every push `cargo check` is run to verify that the code compiles correctly.
13
+
14
+These are to ensure that the project maintains code quality.
15
+
7 16
 ## Conduct
8 17
 
9 18
 Please conduct yourself in a respectful and professional manner.

+ 1
- 0
scripts/importer/.gitignore View File

@@ -1,5 +1,6 @@
1 1
 # Don't commit gems
2 2
 vendor/
3
+Gemfile.lock
3 4
 
4 5
 # Don't commit output
5 6
 importer.sql

+ 4
- 4
scripts/importer/README.md View File

@@ -11,9 +11,9 @@ Run the script with `rake run` or `bundle exec ruby importer.rb`.
11 11
 This uses the following Ruby Gems:
12 12
 - [Mongo](https://rubygems.org/gems/mongo)
13 13
 
14
-These gems require that you have `ruby-devel`
15
-installed in order to build their native bindings.
16
-These should be available from your distrobutions package manager.
14
+This gem requires that you have `ruby-devel`
15
+installed in order to build its native bindings.
16
+This should be available from your distributions package manager.
17 17
 
18
-These gems can be installed locally using `rake install` or
18
+Gems can be installed locally using `rake deps` or
19 19
 `bundle install --path vendor/bundle`.

+ 2
- 2
scripts/importer/Rakefile View File

@@ -1,7 +1,7 @@
1
-task :install do
1
+task :deps do
2 2
     `bundle install --path vendor/bundle`
3 3
 end
4 4
 
5
-task run: [:install] do
5
+task run: [:deps] do
6 6
     `bundle exec ruby importer.rb`
7 7
 end

Loading…
Cancel
Save