Skip to content
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 tags #34

Closed
wants to merge 8 commits into from
Closed

Add tags #34

wants to merge 8 commits into from

Conversation

belgoros
Copy link

@belgoros belgoros commented Jul 6, 2016

Adds a tags topic.

* create gherkin.md
* add feature introduction section
* add step definitions section
 * add hooks
 * add doc strings
 * add background
 * add comments
 * update SUMMARY links
 * add tags.md
@jbpros
Copy link
Member

jbpros commented Jul 6, 2016

Ok, I got it. #34 builds upon #33 which in turn was based on #32.

Would you feel comfortable making branches off of master each time you focus on a different topic so that PRs are more focussed?

If you're not confident enough with Git, don't worry. In that case, I suggest we close #32 and #33 to focus on everything in #34 at once.

@@ -0,0 +1,31 @@
# Tags

Tags are a way to group Scenarios. They are `@`-prefixed strings and you can place as many tags as you like above `Feature, Scenario, Scenario Outline` or `Examples` keywords. Space character are invalid in tags and may separate them.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please backtick-quote each keyword independently

@aslakhellesoy
Copy link
Contributor

This PR/branch seems to be dependent on other PR/branches (there is gherkin and hooks stuff in here). Please keep them separate so we can accept/reject PRs individually

@belgoros
Copy link
Author

belgoros commented Jul 7, 2016

@jbpros you are right about

#34 builds upon #33 which in turn was based on #32.
I suggest we close #32 and #33 to focus on everything in #34 at once.

and that's what I was affraid of. There is no problem for me to start a PR off master (for the next PR ?).
@aslakhellesoy , @jbpros I'll start to apply your notes and come back. Thank you.

@belgoros
Copy link
Author

belgoros commented Jul 7, 2016

@jbpros so what do you suggest, - will you close #32 and #33 and I'll apply the related modifications right on the last one (this one) or should I do that separately ? I didn't read attentively your comment in the very begining. So I'll rebase this PR on the previous ones and submit changes.

@aslakhellesoy
Copy link
Contributor

@jbpros could you please add a note about independent pull requests off master in CONTRIBUTING.md

  * remove line numbers in code examples
  * drop specificities as too complicated for a beginner
  * make Gherkin explanation simpler
@belgoros
Copy link
Author

belgoros commented Jul 7, 2016

I've rebased this branch on its previous ones: #32 and #33 and applied the required modifications. Tell me if I missed something.

aslakhellesoy added a commit that referenced this pull request Jul 13, 2016
## Gherkin Syntax

A Gherkin source file usually looks like this
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add gherkin after backticks to get syntax highlighting

* Don’t use `Background` to set up complicated state unless that state is actually something the client needs to know.
* Keep your `Background` section short.
* Make your `Background` section vivid.
* Keep your scenarios short and don’t have too many.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good guideline, but it's not about Background, is it?

* add gherkin highlighting
* remove line numbers referring
* fix inter document links syntax
* bold key words separately
* add the explanation for Given-When-Then blocks
* capitalise keywords and link to their section
* use bullet list to list key words
* express steps in past tense
* unindent scenarios to be at the same level as Background
* change Good practices to apply not to just the Background
* make a h3 section for Before and After hooks
* describe the difference between Before hook and Background
* make each code tab do the same thing
* remove Around hooks section
@belgoros
Copy link
Author

Done

@stale
Copy link

stale bot commented Nov 8, 2017

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in a week if no further activity occurs.

@stale stale bot added the ⌛ stale Will soon be closed by stalebot unless there is activity label Nov 8, 2017
@stale
Copy link

stale bot commented Nov 15, 2017

This issue has been automatically closed because of inactivity. You can support the Cucumber core team on opencollective.

@stale stale bot closed this Nov 15, 2017
@lock
Copy link

lock bot commented Nov 15, 2018

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot locked as resolved and limited conversation to collaborators Nov 15, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
📖 documentation Improvements or additions to documentation ⌛ stale Will soon be closed by stalebot unless there is activity
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants