Skip to content

Commit 4fc2863

Browse files
amithkkamithkk
committed
Initial commit
0 parents  commit 4fc2863

File tree

9 files changed

+224
-0
lines changed

9 files changed

+224
-0
lines changed

‎.github/CODE_OF_CONDUCT.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# DBoM Community Code of Conduct
2+
3+
Please refer to our [DBoM Community Code of Conduct](https://github.com/DBOMproject/community/blob/master/CODE-OF-CONDUCT.md)

‎.github/ISSUES.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
If you open a GitHub Issue, here is our policy:
2+
3+
1. It must be one of:
4+
- Bug
5+
- Feature Request
6+
- Performance Issue
7+
- Build/Documentation issue
8+
2. The issue being opened must pertain to the repository that it is being opened in
9+
3. The appropriate issue template needs to be filled out
10+
11+
**Why this policy exists:** It helps us focus on the contributions that benefits the whole community. Individual support should be sought on channels like our [mailing list] or [slack]

‎.github/ISSUE_TEMPLATE/00-bug-issue.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
3+
name: Bug Issue
4+
about: Use this template for reporting a bug
5+
labels: 'type:bug'
6+
7+
---
8+
9+
<!-- Kindly ensure that this fits the description of a bug. Check our our Github Issue Policy (https://github.com/DBOMproject/community/blob/master/ISSUES.md) to know more -->
10+
11+
**Your Environment**
12+
13+
- Versions of your services :
14+
- Operating System :
15+
16+
17+
18+
**Describe the current behavior**
19+
20+
**Describe the expected behavior**
21+
22+
**Standalone steps to reproduce the issue**
23+
24+
25+
26+
**Other info / logs:**
27+
28+
<!-- Include any logs or source code that would be helpful to
29+
diagnose the problem. If including tracebacks, please include the full
30+
traceback. Large logs and files should be attached. -->
31+

‎.github/ISSUE_TEMPLATE/10-feature-request.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature Request
3+
about: Use this template for raising a feature request
4+
labels: 'type:feature'
5+
6+
---
7+
8+
<!-- Kindly ensure that this fits the description of a bugissue. Check our our Github Issue Policy (https://github.com/DBOMproject/community/blob/master/ISSUES.md) to know more -->
9+
10+
**System information**
11+
12+
- Version of Services:
13+
- Are you willing to contribute it (Yes/No):
14+
15+
16+
17+
**Describe the feature and the current behavior/state.**
18+
19+
**Will this change the current API? How?**
20+
21+
**Who will benefit with this feature?**
22+
23+
**Miscellaneous Information**

‎.github/ISSUE_TEMPLATE/20-documentation-issue.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Documentation Issue
3+
about: Use this template for raising a feature request
4+
labels: 'type:documentation'
5+
6+
---
7+
8+
<!-- Kindly ensure that this fits the description of a documentation issue. Check our our Github Issue Policy (https://github.com/DBOMproject/community/blob/master/ISSUES.md) to know more -->
9+
10+
**URL(s) with the issue:**
11+
12+
Please provide a link to the documentation entry
13+
14+
**Description of the issue:**
15+
16+
17+
18+
**Submitting a pull request?**
19+
20+
Are you willing to submit a pull request to solve this issue? (Yes/No):

‎.github/ISSUE_TEMPLATE/30-other-issue.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Other Issue
3+
about: Use this template for raising an issue that isn't covered generally
4+
labels: 'type:other'
5+
6+
---
7+
8+
<!-- Check our our Github Issue Policy (https://github.com/DBOMproject/community/blob/master/ISSUES.md) to know more -->
9+
10+
**Description of the issue:**
11+
12+
A short description of the issue.
13+
14+
**Submitting a pull request?**
15+
16+
Are you willing to submit a pull request to solve this issue? (Yes/No):

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!-- Please refer to our contributing documentation for any questions on submitting a pull request, or let us know here if you need any help. -->
2+
3+
## Pull request checklist
4+
5+
Please check if your PR fulfills the following requirements:
6+
- [ ] Tests for the changes have been added (for bug fixes / features)
7+
- [ ] Docs have been reviewed and added / updated if needed (for bug fixes / features)
8+
- [ ] Build was run locally and any changes were pushed
9+
- [ ] Lint has passed locally and any fixes were made for failures
10+
11+
12+
## Pull request type
13+
14+
<!-- Please do not submit updates to dependencies unless it fixes an issue. -->
15+
16+
<!-- Please try to limit your pull request to one type, submit multiple pull requests if needed. -->
17+
18+
Please check the type of change your PR introduces:
19+
- [ ] Bugfix
20+
- [ ] Feature
21+
- [ ] Code style update (formatting, renaming)
22+
- [ ] Refactoring (no functional changes, no api changes)
23+
- [ ] Build related changes
24+
- [ ] Documentation content changes
25+
- [ ] Other (please describe):
26+
27+
28+
## What is the current behavior?
29+
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
30+
31+
Issue Number: N/A
32+
33+
34+
## What is the new behavior?
35+
<!-- Please describe the behavior or changes that are being added by this PR. -->
36+
37+
-
38+
-
39+
-
40+
41+
## Does this introduce a breaking change?
42+
43+
- [ ] Yes
44+
- [ ] No
45+
46+
<!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. -->
47+
48+
49+
## Other information
50+
51+
<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->

‎CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Contributing
2+
3+
We welcome contributions to the Digital Bill of Materials in many forms, and there's always plenty to do!
4+
5+
Please visit the [contributors guide](https://github.com/DBOMproject/community/blob/master/CONTRIBUTING.md) in the docs to learn how to make contributions to this exciting project.

‎README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
#### DBoM Open Source Project Template Instructions
2+
3+
1. Create a new project based on this template
4+
3. Update the README, replacing the contents below as prescribed
5+
3. Delete these instructions and everything up to the _Project Title_ from the README.
6+
7+
8+
9+
# Project Title
10+
11+
**Description**:
12+
13+
Put a meaningful, short, plain-language description of what
14+
this project is trying to accomplish and why it matters.
15+
Describe the problem(s) this project solves.
16+
Describe how this software can improve the lives of its audience.
17+
18+
Other things to include:
19+
20+
- Link to the changelog
21+
- Links to production or demo instances
22+
23+
**Screenshot**
24+
25+
If the software has visual components, place a screenshot after the description
26+
27+
28+
## Installation
29+
30+
Detailed instructions on how to install, configure, and get the project running.
31+
This should be frequently tested to ensure reliability.
32+
33+
## Configuration
34+
35+
If the software is configurable, describe it in detail, either here or in other documentation to which you link.
36+
37+
## Usage
38+
39+
Show users how to use the software.
40+
Be specific.
41+
Use appropriate formatting when showing code snippets.
42+
43+
## How to test the software
44+
45+
If the software includes automated tests, detail how to run those tests.
46+
47+
48+
## Getting help
49+
50+
If you have any queries on insert-project-name, feel free to reach us on any of our [communication channels](https://github.com/DBOMproject/community/blob/master/COMMUNICATION.md)
51+
52+
**Example**
53+
54+
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
55+
56+
## Getting involved
57+
58+
This section should detail why people should get involved and describe key areas you are
59+
currently focusing on; e.g., trying to get feedback on features, fixing certain bugs, building
60+
important pieces, etc.
61+
62+
General instructions on _how_ to contribute should be stated with a link to [CONTRIBUTING](CONTRIBUTING.md).
63+
64+

0 commit comments

Comments
 (0)