Skip to content

Commit d3249d5

Browse files
Sienna ChienSienna Chien
authored andcommitted
docs: linking contribution guide
Signed-off-by: Sienna Chien <siennac@Siennas-MacBook-Air.local>
1 parent 566e22e commit d3249d5

2 files changed

Lines changed: 4 additions & 172 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -8,58 +8,11 @@ We can't wait to collaborate with you!
88

99
## Contributing Code
1010

11-
### Developer's Guide
12-
13-
Please follow our [Developer's Guide](./docs/dev-guide.md) where you can find comprehensive instructions
14-
for common development operations.
15-
16-
### Issues
17-
18-
Prioritization for pull requests is given to those that address and resolve existing GitHub issues. Utilize the available issue labels to identify meaningful and relevant issues to work on.
19-
20-
If you believe that there is a need for a fix and no existing issue covers it, feel free to create a new one.
21-
22-
As a new contributor, we encourage you to start with issues labeled as good first issues.
23-
24-
Your assistance in improving documentation is highly valued, regardless of your level of experience with the project.
25-
26-
To claim an issue that you are interested in, kindly leave a comment on the issue and request the maintainers to assign it to you.
27-
28-
### Committing
29-
30-
We encourage all contributors to adopt [best practices in git commit management](https://www.futurelearn.com/info/blog/telling-stories-with-your-git-history) to facilitate efficient reviews and retrospective analysis. Your git commits should provide ample context for reviewers and future codebase readers.
11+
Please follow the [Contribution guide](https://github.com/kagenti/kagenti/blob/main/CONTRIBUTING.md#contributing-to-this-project) as found in the Kagenti Repository for instructions on how to contribute to our repositories.
3112

32-
A recommended format for final commit messages is as follows:
33-
34-
```text
35-
{Short Title}: {Problem this commit is solving and any important contextual information} {issue number if applicable}
36-
```
37-
38-
### Pull Requests
39-
40-
When submitting a pull request, clear communication is appreciated. This can be achieved by providing the following information:
41-
42-
- Detailed description of the problem you are trying to solve, along with links to related GitHub issues
43-
- Explanation of your solution, including links to any design documentation and discussions
44-
- Information on how you tested and validated your solution
45-
- Updates to relevant documentation and examples, if applicable
46-
47-
The pull request template has been designed to assist you in communicating this information effectively.
48-
49-
Smaller pull requests are typically easier to review and merge than larger ones. If your pull request is big, it is always recommended to collaborate with the maintainers to find the best way to divide it.
50-
51-
See the [making PR](./docs/dev-guide.md#making-a-pr) document for detailed instructions.
52-
53-
## Licensing
54-
55-
Kagenti is [Apache 2.0 licensed](LICENSE) and we accept contributions via
56-
GitHub pull requests.
13+
### Developer's Guide
5714

58-
Please read the following if you're interested in contributing to Kagenti.
15+
Please follow our [Developer's Guide](https://github.com/kagenti/kagenti/blob/main/docs/dev-guide.md#developers-guide), as found in the Kagenti Repository, where you can find comprehensive instructions for common development operations.
5916

60-
## Certificate of Origin
17+
Please note that the section concerning pre-commit does not apply to this repository.
6118

62-
By contributing to this project you agree to the Developer Certificate of
63-
Origin (DCO). This document was created by the Linux Kernel community and is a
64-
simple statement that you, as a contributor, have the legal right to make the
65-
contribution. See the [DCO](DCO) file for details.

docs/dev-guide.md

Lines changed: 0 additions & 121 deletions
This file was deleted.

0 commit comments

Comments
 (0)