Skip to content

Commit

Permalink
Clarify / clean up contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bencompton committed Mar 23, 2024
1 parent b5d642f commit de473a1
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Just as a disclaimer, this package is maintained by a single person who has fair

This project generally aims to have feature parity with Cucumber where it makes sense in the context of Jest. New or experimental ideas are appreciated, but quite honestly may not be given the consideration they deserve due to lack of time. Many people may also have certain niche preferences, but this package is unfortunately not able to accomodate every preference while remaining simple to use and maintainable.

If you're able to get something new and interesting working by adding additional code in your own projects to leverage the package in a unique way, please feel free to share it with the community in the [Discussions](https://github.com/bencompton/jest-cucumber/discussions) area! In the past, ideas have even been incorporated into the package itself--one example is Automatic Step Binding.
If you're able to get something new and interesting working by adding additional code in your own projects to leverage the package in a unique way, please feel free to share it with the community in the [Discussions](https://github.com/bencompton/jest-cucumber/discussions) area! In the past, such ideas have even been incorporated into the package itself--one example is Automatic Step Binding.

## Issues

Issues are generally for reporting bugs and proposing new features, as opposed to asking for support. If you're strugging to get something working, please use the Q&A area under [Discussions](https://github.com/bencompton/jest-cucumber/discussions). There's a good chance it may be someone from the community answering your question instead of the maintainer, though.
Issues in this repo are generally for reporting bugs and proposing new features, as opposed to asking for support. If you're strugging to get something working, you may have better luck in the Q&A area under [Discussions](https://github.com/bencompton/jest-cucumber/discussions). There's a good chance it may be someone from the community answering your question instead of the maintainer, though.

Also, please ensure bug reports have a clear description of the issue and steps to reproduce.

Expand All @@ -22,8 +22,8 @@ When creating PRs, please note the following guidelines:

## Documentation and Examples

Documentation and examples should be concrete and devoid of noise, humor, or "cuteness".
Documentation and examples should be concrete, easily understood, and devoid of noise, humor, or "cuteness".

This package's front page example is about Elon Musk and rockets, which some people may have found amusing, but doesn't actually help new users to understand how teams should write Gherkin in the real world. I remember my team and I initially struggling to understand how to properly use the Gherkin `Rule` keyword, and we were all scratching our heads because the only examples we could find were about Chuck Norris. We would have learned faster if we had examples that demonstrated how the `Rule` keyword should be used in a real system, and maybe the Chuck Norris example would've been more entertaining if it weren't the only example we could find at the time.
This package's front page example is about Elon Musk and rockets, which perhaps some people may have found amusing, but many others may have not because it doesn't actually help new users to understand how teams should write Gherkin in the real world. I remember my team and I initially struggling to understand how to properly use the Gherkin `Rule` keyword many years ago, and we were all scratching our heads because the only examples we could find in the Cucumber docs were about ninjas. We would have learned faster if we had more examples that demonstrated how the `Rule` keyword should be used in a real system, preferably detailing workflows that are widely used and understood, like adding a product to a shopping cart / basket, logging into a web app, making a bank deposit, etc. Examples about ninjas, Chuck Norris, and Elon Musk are probably be more entertaining when they aren't the only examples available.

With this mindset, many of the less concrete examples in this repo have already been replaced with more concrete ones. If your docs or examples are rejected, it's not because you aren't clever or funny enough, it's that it's more important to educate than to entertain.
With this mindset, many of the less concrete examples in this repo have already been replaced with more concrete ones, and at the risk of sounding like a killjoy, we should continute in that direction. If your docs or examples are rejected, it's not because you aren't clever or funny enough, it's that it's more important to educate than to entertain, especially when you may be providing the only examples in existence on how to use a particular feature.

0 comments on commit de473a1

Please sign in to comment.