You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+18-11Lines changed: 18 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
2
2
# Edge-AI-Suites Contributor Guide
3
3
4
-
The following are guidelines for contributing to the Edge AI Suites project, including the code of conduct, submitting issues, and contributing code.
4
+
The following are guidelines for contributing to the Edge AI Suites project, including the code of conduct, submitting issues, and contributing code.
5
5
6
6
# Table of Contents
7
7
@@ -15,37 +15,44 @@ The following are guidelines for contributing to the Edge AI Suites project, inc
15
15
16
16
# Code of Conduct
17
17
18
-
This project and everyone participating in it are governed by the [`CODE_OF_CONDUCT`](CODE_OF_CONDUCT.md) document. By participating, you are expected to adhere to this code.
18
+
This project and everyone participating in it are governed by the [`CODE_OF_CONDUCT`](CODE_OF_CONDUCT.md) document. By participating, you are expected to adhere to this code.
19
19
20
-
# Security
20
+
# Security
21
21
22
-
Read the [`Security Policy`](SECURITY.md).
22
+
Read the [`Security Policy`](SECURITY.md).
23
23
24
24
# Get Started
25
25
26
-
Clone the repository and follow the [`README`](README.md) to get started with the sample applications of interest.
26
+
Clone the repository and follow the [`README`](README.md) or
27
+
[documentation's](https://docs.openedgeplatform.intel.com/) "Get Started" of the chosen
Note that you do not need to clone the entire repository. You can clone just the portion you
35
+
are interested with. To see how ti do it, check out the
36
+
[Contributing to Open Edge Platform](https://docs.openedgeplatform.intel.com/canonical/OEP-articles/contribution-guide.html#repository-cloning-partial-cloning)
37
+
article.
38
+
32
39
33
40
# How to Contribute
34
41
35
42
## Contribute Code Changes
36
43
37
-
> If you want to help improve Edge AI Suites, choose one of the issues reported in [`GitHub Issues`](https://github.com/open-edge-platform/edge-ai-suites/issues) and create a [`Pull Request`](https://github.com/open-edge-platform/edge-ai-suites/pulls) to address it.
44
+
> If you want to help improve Edge AI Suites, choose one of the issues reported in [`GitHub Issues`](https://github.com/open-edge-platform/edge-ai-suites/issues) and create a [`Pull Request`](https://github.com/open-edge-platform/edge-ai-suites/pulls) to address it.
38
45
> Note: Please check that the change hasn't been implemented before you start working on it.
39
46
40
47
## Improve Documentation
41
48
42
49
The easiest way to help with the `Developer Guide` and `User Guide` is to review it and provide feedback on the
43
-
existing articles. Whether you notice a mistake, see the possibility of improving the text, or think more
50
+
existing articles. Whether you notice a mistake, see the possibility of improving the text, or think more
44
51
information should be added, you can reach out to discuss the potential changes.
45
52
46
53
## Report Bugs
47
54
48
-
If you encounter a bug, open an issue in [`Github Issues`](https://github.com/open-edge-platform/edge-ai-suites/issues). Provide the following information to help us
55
+
If you encounter a bug, open an issue in [`Github Issues`](https://github.com/open-edge-platform/edge-ai-suites/issues). Provide the following information to help us
49
56
understand and resolve the issue quickly:
50
57
51
58
- A clear and descriptive title
@@ -59,7 +66,7 @@ understand and resolve the issue quickly:
59
66
60
67
Intel welcomes suggestions for new features and improvements. Follow these steps to make a suggestion:
61
68
62
-
- Check if there's already a similar suggestion in [`Github Issues`](https://github.com/open-edge-platform/edge-ai-suites/issues).
69
+
- Check if there's already a similar suggestion in [`Github Issues`](https://github.com/open-edge-platform/edge-ai-suites/issues).
63
70
- If not, open a new issue and provide the following information:
64
71
- A clear and descriptive title
65
72
- A detailed description of the enhancement
@@ -75,7 +82,7 @@ Before submitting a pull request, ensure you follow these guidelines:
75
82
- Test your changes thoroughly.
76
83
- Document your changes (in code, readme, etc.).
77
84
- Submit your pull request, detailing the changes and linking to any relevant issues.
78
-
- Wait for a review. Intel will review your pull request as soon as possible and provide you with feedback.
85
+
- Wait for a review. Intel will review your pull request as soon as possible and provide you with feedback.
79
86
You can expect a merge once your changes are validated with automatic tests and approved by maintainers.
80
87
81
88
# Development Guidelines
@@ -95,7 +102,7 @@ Clear and informative commit messages make it easier to understand the history o
95
102
- Capitalize the first letter
96
103
- Keep the message concise, ideally under 50 characters
97
104
98
-
Please fill in the details as per the [pull request template](./.github/PULL_REQUEST_TEMPLATE.md) while submitting the
105
+
Please fill in the details as per the [pull request template](./.github/PULL_REQUEST_TEMPLATE.md) while submitting the
0 commit comments