Skip to content

Commit d6e8681

Browse files
authored
docs: adding contribution guidelines (devfile#823)
* docs: adding contribution guidelines Signed-off-by: Michael Hoang <[email protected]> * triggering ci workflow Signed-off-by: Michael Hoang <[email protected]>
1 parent a87448d commit d6e8681

File tree

2 files changed

+64
-0
lines changed

2 files changed

+64
-0
lines changed

CONTRIBUTING.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing
2+
3+
Contributions are welcome!
4+
5+
## Code of Conduct
6+
7+
Before contributing to this repository for the first time, please review our project's [Code of Conduct](https://github.com/devfile/api/blob/main/CODE_OF_CONDUCT.md).
8+
9+
## Getting Started
10+
11+
### Issues
12+
13+
- Open or search for [issues](https://github.com/devfile/api/issues) with the label `area/api`.
14+
15+
- If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/devfile/api/issues/new/choose). You can tag issues with `/area api`.
16+
17+
### Building
18+
19+
To build the CRD and the various schemas, you don't need to install any pre-requisite apart from `docker`.
20+
In the root directory, just run the following command:
21+
22+
```
23+
./docker-run.sh ./build.sh
24+
```
25+
26+
### Testing
27+
28+
Find more information about tests in the [testing document](test/README.md).
29+
30+
```
31+
# schemaTest approach
32+
cd test/v200/schemaTest
33+
go test -v
34+
```
35+
36+
```
37+
# apiTest approach
38+
cd test/v200/apiTest
39+
go test -v
40+
```
41+
42+
### Pull Requests
43+
44+
All commits must be signed off with the footer:
45+
46+
```
47+
Signed-off-by: First Lastname <[email protected]>
48+
```
49+
50+
Once you set your user.name and user.email in your git config, you can sign your commit automatically with git commit -s. When you think the code is ready for review, create a pull request and link the issue associated with it.
51+
52+
Owners of the repository will watch out for and review new PRs.
53+
54+
If comments have been given in a review, they have to be addressed before merging.
55+
56+
After addressing review comments, don’t forget to add a comment in the PR afterward, so everyone gets notified by Github and knows to re-review.

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,11 @@ As soon as the devworkspace is opened, you should be able to:
6363
- `samples/`
6464
- `devfile-support/samples`
6565
- have `yaml` language support (completion and documentation) based on the current Json schemas.
66+
67+
## Contributing
68+
69+
Please see our [contributing.md](./CONTRIBUTING.md).
70+
71+
## License
72+
73+
Apache License 2.0, see [LICENSE](./LICENSE) for details.

0 commit comments

Comments
 (0)