diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c4acc61c..4eaf84daa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Contributing to TeSS -While TeSS was originally developed to serve as the training portal for [ELIXIR](https://www.elixir-europe.org/), it endeavours to be a generic training platform that can be easily customized and re-used in other communities. +While TeSS was originally developed to serve as the training portal for [ELIXIR](https://www.elixir-europe.org/), it endeavours to be a generic training platform that can be easily customized and reused in other communities. To that end we welcome and encourage new contributors to get involved and help to shape and improve TeSS. This document discusses and explains different ways you can contribute to TeSS. You can find a code checklist at the end of this document to summarize the important points. diff --git a/app/assets/javascripts/map.js b/app/assets/javascripts/map.js index 8efde07b9..c71f226eb 100644 --- a/app/assets/javascripts/map.js +++ b/app/assets/javascripts/map.js @@ -356,7 +356,7 @@ var EventsMap = { var getTab = function () { var tab = window.location.hash; if (tab) { - return tab.substring(1) /* stip hash */ + return tab.substring(1) /* strip hash */ } else { return '' } diff --git a/app/assets/stylesheets/application.scss b/app/assets/stylesheets/application.scss index f3974e377..f7fe43481 100644 --- a/app/assets/stylesheets/application.scss +++ b/app/assets/stylesheets/application.scss @@ -493,7 +493,7 @@ ul.unstyled { border: none; } -/* The max width is dependant on the container (more info below) */ +/* The max width is dependent on the container (more info below) */ .popover { max-width: 500px !important; /* Max Width of the popover (depending on the container!) */ } diff --git a/app/models/event.rb b/app/models/event.rb index 571acf006..5b10940e4 100644 --- a/app/models/event.rb +++ b/app/models/event.rb @@ -388,7 +388,7 @@ def geocoding_cache_lookup redis = Redis.new(url: TeSS::Config.redis_url) if redis.exists?(location) self.latitude, self.longitude = JSON.parse(redis.get(location)) - Rails.logger.info("Re-using: #{location}") + Rails.logger.info("Reusing: #{location}") end rescue Redis::BaseError => e raise e unless Rails.env.production? diff --git a/app/views/common/_topic_suggestions.html.erb b/app/views/common/_topic_suggestions.html.erb index b524ee5ff..ce429ae07 100644 --- a/app/views/common/_topic_suggestions.html.erb +++ b/app/views/common/_topic_suggestions.html.erb @@ -9,7 +9,7 @@
- <%= sugestion.material.description %> + <%= suggestion.material.description %>
diff --git a/app/views/content_providers/partials/_content_provider_info.html.erb b/app/views/content_providers/partials/_content_provider_info.html.erb index cb03f5276..79cc6efca 100644 --- a/app/views/content_providers/partials/_content_provider_info.html.erb +++ b/app/views/content_providers/partials/_content_provider_info.html.erb @@ -9,7 +9,7 @@ Variable that should be available

<%# Link to either external content provider's page or to the content provider's object in TeSS, - based on which controller/view is currenlty active %> + based on which controller/view is currently active %> <% if controller_name == 'content_providers' url = content_provider.url diff --git a/app/workers/edit_suggestion_worker.rb b/app/workers/edit_suggestion_worker.rb index d6d3fdda3..44025430d 100644 --- a/app/workers/edit_suggestion_worker.rb +++ b/app/workers/edit_suggestion_worker.rb @@ -2,7 +2,7 @@ class EditSuggestionWorker include Sidekiq::Worker # TODO: Should a random time delay go in here such that the chastisement of - # TODO: BioPortal is somewhat mimimised? + # TODO: BioPortal is somewhat minimised? def perform(arg_array) suggestible_id, suggestible_type = arg_array logger.debug "ID: #{suggestible_id}" diff --git a/config/initializers/friendly_id.rb b/config/initializers/friendly_id.rb index f064f1e59..c3980a72b 100644 --- a/config/initializers/friendly_id.rb +++ b/config/initializers/friendly_id.rb @@ -31,7 +31,7 @@ # MyModel.find('foo') # # This is significantly more convenient but may not be appropriate for - # all applications, so you must explicity opt-in to this behavior. You can + # all applications, so you must explicitly opt-in to this behavior. You can # always also configure it on a per-model basis if you prefer. # # Something else to consider is that using the :finders addon boosts diff --git a/config/locales/en.yml b/config/locales/en.yml index 727d7ca70..d4e60a7cd 100644 --- a/config/locales/en.yml +++ b/config/locales/en.yml @@ -716,7 +716,7 @@ en: keywords: "Provide words or terms that clearly identify the learning path's topics." licence: 'Select the licence for the learning path.' objectives: > - Describe the knowledge, skills or abilities that students should acquire throught the completion or use of the + Describe the knowledge, skills or abilities that students should acquire through the completion or use of the learning path. other_types: 'Enter the types of resources that are not included on the above list.' part_of: 'Describe the larger service of training to which this learning path belongs.' diff --git a/lib/ingestors/github_ingestor.rb b/lib/ingestors/github_ingestor.rb index d5614b553..6cc65eafc 100644 --- a/lib/ingestors/github_ingestor.rb +++ b/lib/ingestors/github_ingestor.rb @@ -155,7 +155,7 @@ def fetch_licence(licence) end # DOI – Fetches DOI from various sources in a repo - # I chose to only read the `README.md` as it seems to have the DOI badge almost everytime. + # I chose to only read the `README.md` as it seems to have the DOI badge almost every time. # Whereas enabling the fetching of CITATION.cff or CITATION.md would result in increasing # the number of api request. def fetch_doi(full_name) diff --git a/lib/ingestors/material_csv_ingestor.rb b/lib/ingestors/material_csv_ingestor.rb index 4ef34e9a3..ea015e1e9 100644 --- a/lib/ingestors/material_csv_ingestor.rb +++ b/lib/ingestors/material_csv_ingestor.rb @@ -15,7 +15,7 @@ def self.config def read(url) begin - # Google spreadsheet convertor + # Google spreadsheet converter url = gsheet_to_csv(url) # parse table diff --git a/public/api/definitions/tess.yml b/public/api/definitions/tess.yml index 4abe2470b..40255dd59 100644 --- a/public/api/definitions/tess.yml +++ b/public/api/definitions/tess.yml @@ -980,11 +980,11 @@ components: latitude: type: string nullable: true - description: The latitude co-ordinate of the event. + description: The latitude coordinate of the event. longitude: type: string nullable: true - description: The longitude co-ordinate of the event. + description: The longitude coordinate of the event. created-at: type: string description: The date the event was first created on TeSS. @@ -1240,7 +1240,7 @@ components: licence: type: string nullable: true - description: The licence chosen to determine how the material may be re-used. + description: The licence chosen to determine how the material may be reused. difficulty-level: nullable: true type: string @@ -1556,7 +1556,7 @@ components: type: string licence: type: string - description: The licence chosed to determine how the workflow may be re-used. + description: The licence chosen to determine how the workflow may be reused. difficulty-level: type: string description: The difficulty level comprehension of the workflow requires. diff --git a/solr/conf/schema.xml b/solr/conf/schema.xml index 11c16cffc..99e74675b 100644 --- a/solr/conf/schema.xml +++ b/solr/conf/schema.xml @@ -109,7 +109,7 @@ indexed: true if this field should be indexed (searchable or sortable) stored: true if this field should be retrievable compressed: [false] if this field should be stored using gzip compression - (this will only apply if the field type is compressable; among + (this will only apply if the field type is compressible; among the standard field types, only TextField and StrField are) multiValued: true if this field may contain multiple values per document omitNorms: (expert) set to true to omit the norms associated with diff --git a/test/controllers/subscriptions_controller_test.rb b/test/controllers/subscriptions_controller_test.rb index e61adb735..033003826 100644 --- a/test/controllers/subscriptions_controller_test.rb +++ b/test/controllers/subscriptions_controller_test.rb @@ -111,7 +111,7 @@ def initialize assert_response :forbidden end - test 'should delete a subscription via unsubcribe link' do + test 'should delete a subscription via unsubscribe link' do sub = subscriptions(:daily_subscription) assert_difference('Subscription.count', -1) do @@ -121,7 +121,7 @@ def initialize assert_response :success end - test 'should not delete a subscription via unsubcribe link with invalid code' do + test 'should not delete a subscription via unsubscribe link with invalid code' do sub = subscriptions(:daily_subscription) sub2 = subscriptions(:weekly_subscription) diff --git a/test/models/event_test.rb b/test/models/event_test.rb index fd25b901a..d4f6140a0 100644 --- a/test/models/event_test.rb +++ b/test/models/event_test.rb @@ -267,7 +267,7 @@ class EventTest < ActiveSupport::TestCase test 'enqueues a geocoding worker after creating an event' do assert_difference('GeocodingWorker.jobs.size', 1) do parameters = @mandatory.merge({ user: users(:regular_user), title: 'New event', url: 'http://example.com', - online: false, description: 'event to test enqueing of geocoding worker', + online: false, description: 'event to test enqueuing of geocoding worker', venue: 'A place', city: 'Manchester', country: 'UK', postcode: 'M16 0TH' }) event = Event.create(parameters) assert event.errors[:url].empty? diff --git a/test/models/subscription_test.rb b/test/models/subscription_test.rb index 02b891ee2..d845c9a27 100644 --- a/test/models/subscription_test.rb +++ b/test/models/subscription_test.rb @@ -112,7 +112,7 @@ class SubscriptionTest < ActiveSupport::TestCase end test '24-hour subscription is due slightly before 24 hours' do - # To prevent "mis-alignment" with daily cronjob. + # To prevent "misalignment" with daily cronjob. sub = Subscription.new(frequency: :daily, user: users(:regular_user), query: 'test', subscribable_type: 'Material', last_checked_at: 60.minutes.ago) sub.save! diff --git a/test/unit/fairsharing/client_test.rb b/test/unit/fairsharing/client_test.rb index 32dc38669..d159e8b9f 100644 --- a/test/unit/fairsharing/client_test.rb +++ b/test/unit/fairsharing/client_test.rb @@ -34,7 +34,7 @@ class ClientTest < ActiveSupport::TestCase assert_equal @token, @redis.hget(Fairsharing::Client::REDIS_KEY, 'token') end - test 'should re-use token from @redis' do + test 'should reuse token from @redis' do set_cached_token('abcdefg', 1_669_997_273) VCR.use_cassette('fairsharing/get_token') do @@ -48,7 +48,7 @@ class ClientTest < ActiveSupport::TestCase assert_equal 'abcdefg', @redis.hget(Fairsharing::Client::REDIS_KEY, 'token') end - test 'should not re-use token from @redis if expired' do + test 'should not reuse token from @redis if expired' do set_cached_token('abcdefg', 3.days.ago.to_i) VCR.use_cassette('fairsharing/get_token') do