Skip to content

Commit 15bb710

Browse files
committed
docs: add cont and support
1 parent 7a707e4 commit 15bb710

File tree

2 files changed

+64
-0
lines changed

2 files changed

+64
-0
lines changed

CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributing
2+
3+
First off, thank you for considering contributing to this project.
4+
5+
## Reporting Issues
6+
7+
Before submitting an issue, please check the issue tracker to ensure that the issue hasn't already been reported. If you find your issue already reported, you can subscribe to that issue to receive updates. If you have any additional information to add, please comment on the issue. If the issue is unnasigned and you'd like to contribute, assign the issue to yourself.
8+
9+
## How to Contribute
10+
11+
If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.
12+
13+
If you don't see your idea listed, and you think it fits into the goals of this project, do one of the following:
14+
15+
- If your contribution is minor, such as a typo fix, open a pull request.
16+
- If your contribution is major, or you have not yet decided how to implement your idea, open an issue to discuss it. This allows other contributors to point out any potential flaws or to help you flesh out your idea.
17+
18+
### Pull Requests
19+
20+
1. Fork the repository and create your branch from `main`.
21+
2. Write some code
22+
3. Make sure your code lints.
23+
4. Issue that pull request!
24+
25+
### Commit Messages
26+
27+
Write meaningful commit messages that provide insight into the changes made.
28+
29+
## Finding Bugs
30+
31+
If you find a bug, please report it in the issue tracker with a detailed description.
32+
33+
## Feature Requests
34+
35+
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. Please provide as much detail and context as possible.
36+
37+
## License
38+
39+
By contributing to this project, you agree that your contributions will be licensed under MIT.
40+
41+
## Acknowledgments
42+
43+
Your contributions are sincerely appreciated. We want to make contributing to this project as easy and transparent as possible, whether it's:
44+
45+
- Reporting a bug
46+
- Discussing the current state of the code
47+
- Submitting a fix
48+
- Proposing new features
49+
50+
Thank you for your interest in contributing

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,22 @@ go-ctrf-json-reporter can be used in conjunction with gotestsum
9090
gotestsum --jsonfile gotestsum.json && go-ctrf-json-reporter < gotestsum.json
9191
```
9292

93+
## Test Object Properties
94+
95+
The test object in the report includes the following [CTRF properties](https://ctrf.io/docs/schema/test):
96+
97+
| Name | Type | Required | Details |
98+
| ---------- | ------ | -------- | ----------------------------------------------------------------------------------- |
99+
| `name` | String | Required | The name of the test. |
100+
| `status` | String | Required | The outcome of the test. One of: `passed`, `failed`, `skipped`, `pending`, `other`. |
101+
| `duration` | Number | Required | The time taken for the test execution, in milliseconds. |
102+
93103
## Troubleshoot
94104

95105
### Command Not Found
96106

97107
When running go-ctrf-json-reporter results in a "command not found" error this usually means that the Go bin directory is not in your system's PATH.
108+
109+
## Support Us
110+
111+
If you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.

0 commit comments

Comments
 (0)