Skip to content

Commit a87b3c2

Browse files
added docs files
1 parent 8093036 commit a87b3c2

File tree

7 files changed

+161
-0
lines changed

7 files changed

+161
-0
lines changed

.github/workflows/changelog.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Changelog
2+
on:
3+
release:
4+
types:
5+
- created
6+
jobs:
7+
changelog:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: "✏️ Generate release changelog"
11+
uses: heinrichreimer/github-changelog-generator-action@v2.3
12+
with:
13+
token: ${{ secrets.GITHUB_TOKEN }}

AUTHORS.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Authors
2+
3+
This file lists the main authors of the **KeywordEngine** project.
4+
5+
## Maintainers
6+
7+
- [Vikash Chauhan](https://github.com/vikashchauhan51) - Project creator, Core developer and architect.
8+

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
- Fix: fixed steps index order issue
2+
- Docs (#3)
3+
- Updated README.md (#2)
4+
- setup package configuration (#1)
5+
- Update README.md
6+
- DI test example
7+
- Added test context and DI resolver
8+
- Added docs
9+
- Added test
10+
- Response imporivement
11+
- inti commit

CODE_OF_CONDUCT.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others' private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,<br>harassment of an individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing to KeywordEngine
2+
3+
Thank you for your interest in contributing to **KeywordEngine** !
4+
5+
We welcome contributions from anyone, regardless of their background or level of experience.
6+
7+
## How to Contribute
8+
9+
There are many ways you can contribute to KeywordEngine:
10+
11+
- **Report bugs**: If you find a bug in the project, please report it by [opening an issue](https://github.com/VikashChauhan51/keyword-engine/issues/new) on our GitHub repository. Be sure to include as much detail as possible, including steps to reproduce the bug, so we can fix it quickly.
12+
13+
- **Request features**: If there's a feature you'd like to see in KeywordEngine, you can request it by [opening an issue](https://github.com/VikashChauhan51/keyword-engine/issues/new) on our GitHub repository. Be sure to describe the feature in detail and explain why it would be useful.
14+
15+
- **Submit pull requests**: If you've made changes to the code that you'd like us to include in the project, you can submit a [pull request](https://github.com/VikashChauhan51/keyword-engine/pulls) on our GitHub repository. Be sure to follow our [code style guidelines](#code-style-guidelines) and include tests for any new features or bug fixes.
16+
17+
18+
## Code Style Guidelines
19+
20+
We follow the [Google C# Style Guide](https://google.github.io/styleguide/csharp-style.html) for our C# code. Please make sure your code follows these guidelines before submitting a pull request.
21+
22+
## Testing
23+
24+
We use [Nunit Test](https://nunit.org/) for our unit tests. Please include tests for any new features or bug fixes and make sure all tests pass before submitting a pull request.
25+
26+
## Code of Conduct
27+
28+
We have adopted the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.

CONTRIBUTORS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[Vikash Chauhan](https://github.com/VikashChauhan51)

README.DEV.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# KeywordEngine
2+
3+
The [KeywordEngine](https://www.nuget.org/packages/KeywordEngine) is a keyword driven framework execution engine for automation test cases.
4+
It can easily integrate with any C# unit testing frameworks like **Nunit**,**XUnit**, and **MSTest**.
5+
6+
## Prerequisite:
7+
1. [Microsoft Visual Studio 2022 IDE](https://visualstudio.microsoft.com/).
8+
2. [Git](https://git-scm.com/download/).
9+
10+
## Local Setup:
11+
1. ```git clone https://github.com/VikashChauhan51/keyword-engine.git```.
12+
2. Open project with VS.
13+
3. Restore all packages.
14+
4. Build project.
15+
16+
## Contributing ![GitHub](https://img.shields.io/github/contributors/vikashchauhan51/keyword-engine)
17+
18+
Please read
19+
[CONTRIBUTING.md](https://github.com/vikashchauhan51/keyword-engine/blob/master/CONTRIBUTING.md) for
20+
details on our code of conduct, and the process for submitting pull requests to
21+
us. See also the list of
22+
[contributors](https://github.com/vikashchauhan51/keyword-engine/graphs/contributors) who
23+
participated in this project.
24+
25+
## License ![GitHub](https://img.shields.io/github/license/vikashchauhan51/keyword-engine)
26+
27+
This project is licensed under the MIT - see the
28+
[LICENSE.md](https://github.com/vikashchauhan51/keyword-engine/blob/master/LICENSE) file for details

0 commit comments

Comments
 (0)