Skip to content

Commit

Permalink
Update docs and repo infrastructure (#12)
Browse files Browse the repository at this point in the history
* Move CONTRIBUTING.md to root so it shows up in the GitHub README tabs along with the LICENSE

* Add bug and enhancement tags to issue templates

* Remove contact links from issue config.yml

* Add PR template

* Add docs directory

* Run rubocop autocorrect

* Add frozen_string_literal: true to .rb files

* Exclude _site/ from rubocop lint

* Run rubocop autocorrect
  • Loading branch information
phrdang authored Jun 19, 2024
1 parent 82377bb commit 18d52ba
Show file tree
Hide file tree
Showing 10 changed files with 32 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
labels: ['bug']
assignees: ''

---
Expand Down
6 changes: 1 addition & 5 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/kevinlin1/just-the-class/discussions
about: Ask questions and discuss with other community members
blank_issues_enabled: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
labels: ['enhancement']
assignees: ''

---
Expand Down
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Preliminaries

- [ ] I have read CONTRIBUTING.md
- [ ] I have added tests, if applicable
- [ ] I have fixed CI issues
- [ ] I have set reviewer(s), assignee(s), and label(s)

## Summary

Describe what you changed and why.

If this address an issue, mention that it fixes that issue.

Attach screenshots or screen recordings, if helpful.
6 changes: 6 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
require:
- rubocop-rspec

AllCops:
NewCops: enable
Exclude:
- '_site/**/*'

File renamed without changes.
4 changes: 3 additions & 1 deletion Gemfile
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# frozen_string_literal: true

source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
gem 'jekyll-sitemap'
gem 'webrick'
gem 'just-the-docs'
gem 'webrick'

group :development, :test do
gem 'axe-core-capybara'
Expand Down
1 change: 1 addition & 0 deletions docs/DELETEME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
A temporary file so the docs directory is checked into git
4 changes: 3 additions & 1 deletion spec/accessibility_spec.rb
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
describe 'course website', type: :feature, js: true do
# frozen_string_literal: true

describe 'course website', :js, type: :feature do
before :all do
visit('/sitemap.xml')
sitemap_links = page.html.scan(%r{<loc>.+</loc>})
Expand Down
2 changes: 2 additions & 0 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# frozen_string_literal: true

# This file was generated by the `rspec --init` command. Conventionally, all
# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
# The generated `.rspec` file contains `--require spec_helper` which will cause
Expand Down

0 comments on commit 18d52ba

Please sign in to comment.