New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some docs info #3114

Merged
merged 2 commits into from Jul 31, 2018

Conversation

Projects
None yet
4 participants
@stefannibrasil
Collaborator

stefannibrasil commented Jul 21, 2018

Fixes #3115
@publiclab/reviewers could you give me more tips to add to those docs?

When @milaaraujo and I were reading and studying the code a few weeks ago, we found some space for improvement. Would appreciate if you could give more tips here. For example, we don't know exactly how to explain more about the stable and unstable branches and how to use them.

Thanks!

Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!

  • [ ✔️ ] tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR -- or run tests locally with rake test
  • [ ✔️ ] code is in uniquely-named feature branch and has no merge conflicts
  • [ ✔️] PR is descriptively titled
  • [ ✔️ ] ask @publiclab/reviewers for help, in a comment below

We're happy to help you get this ready -- don't be afraid to ask for help, and don't be discouraged if your tests fail at first!

If tests do fail, click on the red X to learn why by reading the logs.

Please be sure you've reviewed our contribution guidelines at https://publiclab.org/contributing-to-public-lab-software

We have a loose schedule of reviewing and pulling in changes every Tuesday and Friday, and publishing changes on Fridays.

Thanks!

@wafflebot wafflebot bot added the in progress label Jul 21, 2018

@stefannibrasil stefannibrasil force-pushed the milaaraujo:some-documentation-improvement branch from 2d6b84e to 4d5b4e4 Jul 21, 2018

@plotsbot

This comment has been minimized.

Collaborator

plotsbot commented Jul 21, 2018

1 Warning
⚠️ It looks like you merged from master in this pull request. Please rebase to get rid of the merge commits – you may want to rewind the master branch and rebase instead of merging in from master, which can cause problems when accepting new code!
1 Message
📖 @stefannibrasil Thank you for your pull request! I’m here to help with some tips and recommendations. Please take a look at the list provided and help us review and accept your contribution! And don’t be discouraged if you see errors – we’re here to help.

Generated by 🚫 Danger

## Solr tests
Solr (search) tests (generally not recommended!) require [installing the Solr search engine](#solr-search-engine) (see above). Once you've done that, you still need to turn it off in development mode before running tests, with `rake sunspot:solr:stop`. Read more about [this issue here](https://github.com/publiclab/plots2/issues/832#issuecomment-249695309).
Solr (search) tests (generally not recommended!) require [installing the Solr search engine](#solr-search-engine) (see above). Once you've done that, you still need to turn it off in development mode before running tests, with `rake sunspot:solr:stop`. Read more about [this issue here](https://github.com/publiclab/plots2/issues/832#issuecomment-249695309).

This comment has been minimized.

@jywarren

jywarren Jul 23, 2018

Contributor

We can remove this whole section on Solr - as we've stopped using it! Thank you!!!!

@@ -60,10 +60,18 @@ And to run just a single test within a file:
`ruby -I test test/functional/some_file.rb --name=name_of_test`
### Testing mails in development envirmoment
### Testing mails in development environment

This comment has been minimized.

@jywarren

jywarren Jul 23, 2018

Contributor

😆 thanks for the catch!!!

Same links would work, no modification in links are required.
It will also show us how our actual mail will look like.
Mail will be same as actual mail we will get in production.
## Testing branches

This comment has been minimized.

@jywarren

jywarren Jul 23, 2018

Contributor

🎉

a stable and an unstable. Those last two are used to test new code before sending
them to production.
If you need to use the stable or the unstable branch,
please ask if someone else is already using it.

This comment has been minimized.

@jywarren

jywarren Jul 23, 2018

Contributor

...in the chatroom (https://publiclab.org/chat) would be great!

@stefannibrasil stefannibrasil force-pushed the milaaraujo:some-documentation-improvement branch from 4d5b4e4 to 23b69d1 Jul 24, 2018

@stefannibrasil

This comment has been minimized.

Collaborator

stefannibrasil commented Jul 24, 2018

hi @jywarren thanks for the tips, I updated the files with them just now :)

@stefannibrasil

This comment has been minimized.

Collaborator

stefannibrasil commented Jul 29, 2018

hi @jywarren do you think there s still something to add here? :)

@stefannibrasil stefannibrasil referenced this pull request Jul 29, 2018

Merged

Link addition to email for marking comment as spam #3163

5 of 5 tasks complete
@jywarren

This comment has been minimized.

Contributor

jywarren commented Jul 31, 2018

OK! Merging!!! Glad that testing bug got fixed! 👍

@jywarren jywarren merged commit 7b77fb6 into publiclab:master Jul 31, 2018

3 checks passed

codeclimate All good!
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
danger/danger ⚠️ 1 Warning. Don't worry, everything is fixable.
Details

@wafflebot wafflebot bot removed the review-me label Jul 31, 2018

@stefannibrasil stefannibrasil deleted the milaaraujo:some-documentation-improvement branch Aug 1, 2018

@milaaraujo milaaraujo self-assigned this Oct 20, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment