Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Also add CONTRIBUTING.md inside .github dir
- Loading branch information
1 parent
7cbab33
commit 554fef5
Showing
5 changed files
with
51 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# :pray: Contributing | ||
|
||
Thank you for considering or deciding to contribute, this is much appreciated! | ||
Any kind of bug reports and pull requests are encouraged and welcome on GitHub at | ||
https://github.com/renderedtext/render_async. | ||
|
||
## Installing dependencies | ||
|
||
You can install all needed dependencies by running `bin/setup`. | ||
|
||
## Running RSpec tests | ||
|
||
You can run either `rake spec` or `bundle exec rspec` to run all the RSpec tests | ||
in the project. | ||
|
||
## Running integration tests | ||
|
||
There is a simple command `bin/integration-tests` which sets up 2 submodules, | ||
and runs Cucumber features in them. | ||
|
||
There are 2 submodules for render_async. The submodules are Rails 5 and Rails 6 | ||
projects which are located in: | ||
|
||
- `spec/fixtures/rails-5-base-app`, and | ||
- `spec/fixtures/rails-6-base-app`. | ||
|
||
You can find [Rails 5 base app here](https://github.com/nikolalsvk/rails-5-base-app/tree/render-async), | ||
and the [Rails 6 base app here](https://github.com/nikolalsvk/rails-6-base-app/tree/render-async). | ||
|
||
Each of them have different use cases of render_async defined in `app/views/render_asyncs/_use_cases.html.erb` in their repos. | ||
All the feature tests are inside `features/render_async.feature` and `features/render_async_jquery.feature` files. | ||
|
||
If you are adding one or more feature tests or use cases, make sure to make a | ||
PR on those repos as well and include them in the PR on the render_async repo. | ||
|
||
## Need help | ||
|
||
Got any issues or difficulties? | ||
Join [render_async's Discord channel](https://discord.gg/SPfbeRm) | ||
and ask questions there. We will try to respond to you as quickly as possible. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Submodule rails-6-base-app
updated
15 files
+1 −0 | .rspec | |
+8 −1 | Gemfile | |
+75 −4 | Gemfile.lock | |
+59 −2 | app/views/render_asyncs/_use_cases.html.erb | |
+9 −0 | config/cucumber.yml | |
+50 −0 | features/render_async.feature | |
+55 −0 | features/render_async_jquery.feature | |
+0 −0 | features/step_definitions/.gitkeep | |
+78 −0 | features/step_definitions/render_async_steps.rb | |
+60 −0 | features/support/env.rb | |
+76 −0 | lib/tasks/cucumber.rake | |
+11 −0 | script/cucumber | |
+61 −0 | spec/rails_helper.rb | |
+96 −0 | spec/spec_helper.rb | |
+22 −24 | yarn.lock |