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

Readme rewrite #715

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Readme rewrite #715

wants to merge 2 commits into from

Conversation

youtux
Copy link
Contributor

@youtux youtux commented Oct 13, 2024

I want to overhaul the documentation. I asked some AI to rewrite the Readme, and got half way through it.

Here are also some recommendations:

To improve the README file for pytest-bdd and enhance the documentation at https://pytest-bdd.readthedocs.io/en/stable/, we should focus on providing clear, concise, and well-structured information. The README should serve as a comprehensive introduction to the library, highlighting its key features, benefits, and usage examples. By organizing the content effectively and including relevant examples, we can make it easier for users to understand and start using pytest-bdd in their projects.

## Step by step plan
1. Update the introduction to clearly explain what pytest-bdd is, its purpose, and its main benefits. Emphasize how it extends pytest to support Behavior-Driven Development (BDD) and facilitates collaboration between developers and stakeholders.

2. Provide a clear and concise installation guide, including the command to install pytest-bdd using pip and any additional dependencies or requirements.

3. Create a "Getting Started" section that walks users through a simple example of how to write a feature file and the corresponding test code using pytest-bdd. Include code snippets and explanations to make it easy for users to follow along.

4. Organize the README into logical sections, such as:
   - Introduction
   - Installation
   - Getting Started
   - Key Features
   - Usage Examples
   - Configuration Options
   - Contributing Guidelines
   - License Information

5. In the "Key Features" section, highlight the main features and capabilities of pytest-bdd, such as:
   - Integration with pytest
   - Support for Gherkin syntax
   - Step definitions using decorators
   - Scenario Outlines and Examples
   - Hooks for customization
   - Reporting and integration with other tools

6. Provide more detailed usage examples that demonstrate how to use pytest-bdd for different scenarios, such as parameterized steps, background steps, and tags.

7. Include information on how to configure pytest-bdd using command-line options and pytest configuration files.

8. Add a "Contributing Guidelines" section to encourage users to contribute to the project, including instructions on how to set up the development environment, running tests, and submitting pull requests.

9. Ensure that the README is well-formatted, using proper headings, bullet points, and code blocks to improve readability.

10. Include links to additional resources, such as the full documentation, issue tracker, and community channels (if available) to help users find more information and support.

Please confirm if this plan aligns with your goals for improving the pytest-bdd README and documentation. Let me know if you have any additional suggestions or requirements!

Copy link

codecov bot commented Oct 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.59%. Comparing base (c370160) to head (0c1ce9d).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #715   +/-   ##
=======================================
  Coverage   95.59%   95.59%           
=======================================
  Files          55       55           
  Lines        2064     2064           
  Branches      233      233           
=======================================
  Hits         1973     1973           
  Misses         55       55           
  Partials       36       36           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

* Use AI to help rewrite text
* Fixed gherkin file examples (the strict gherkin parser would not have parsed some)
* Remove "Multiline steps" section, as they are not supported in that way anymore, and we are going to implement proper support for Docstrings soon
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant