Skip to content

Commit e0853ec

Browse files
authored
Update auto-generated templates with project information
Update the auto-generated README.md, LICENSE.txt, CONTRIBUTING.md, and SECURITY.md templates with correct project details.
2 parents e5c56c3 + 3863183 commit e0853ec

File tree

4 files changed

+41
-68
lines changed

4 files changed

+41
-68
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to <REPLACE-ME>
1+
# Contributing to qcom-dtb-metadata
22

33
Hi there!
44
We’re thrilled that you’d like to contribute to this project.
@@ -11,10 +11,10 @@ In general, contributors should develop on branches based off of `main` and pull
1111
## Submitting a pull request
1212

1313
1. Please read our [code of conduct](CODE-OF-CONDUCT.md) and [license](LICENSE.txt).
14-
1. [Fork](https://github.com/qualcomm/<REPLACE-ME>/fork) and clone the repository.
14+
1. [Fork](https://github.com/qualcomm/qcom-dtb-metadata/fork) and clone the repository.
1515

1616
```bash
17-
git clone https://github.com/<username>/<REPLACE-ME>.git
17+
git clone https://github.com/<username>/qcom-dtb-metadata.git
1818
```
1919

2020
1. Create a new branch based on `main`:
@@ -26,7 +26,7 @@ In general, contributors should develop on branches based off of `main` and pull
2626
1. Create an upstream `remote` to make it easier to keep your branches up-to-date:
2727

2828
```bash
29-
git remote add upstream https://github.com/qualcomm/<REPLACE-ME>.git
29+
git remote add upstream https://github.com/qualcomm/qcom-dtb-metadata.git
3030
```
3131

3232
1. Make your changes, add tests, and make sure the tests still pass.
@@ -50,7 +50,7 @@ In general, contributors should develop on branches based off of `main` and pull
5050

5151
The `-u` is shorthand for `--set-upstream`. This will set up the tracking reference so subsequent runs of `git push` or `git pull` can omit the remote and branch.
5252

53-
1. [Submit a pull request](https://github.com/qualcomm/<REPLACE-ME>/pulls) from your branch to `main`.
53+
1. [Submit a pull request](https://github.com/qualcomm/qcom-dtb-metadata/pulls) from your branch to `main`.
5454
1. Pat yourself on the back and wait for your pull request to be reviewed.
5555

5656
## Security Analysis of Pull Requests
@@ -68,7 +68,7 @@ By submitting a PR, you agree to participate in this process and help us keep th
6868

6969
Here are a few things you can do that will increase the likelihood of your pull request to be accepted:
7070

71-
- Follow the existing style where possible. **INSERT LINK TO STYLE, e.g. PEP8 for python**
71+
- Follow the existing style where possible.
7272
- Write tests.
7373
- Keep your change as focused as possible.
7474
If you want to make multiple independent changes, please consider submitting them as separate pull requests.

LICENSE.txt

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,31 @@
11
Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
22

33
Redistribution and use in source and binary forms, with or without
4-
modification, are permitted provided that the following conditions are
5-
met:
6-
* Redistributions of source code must retain the above copyright
7-
notice, this list of conditions and the following disclaimer.
8-
* Redistributions in binary form must reproduce the above
9-
copyright notice, this list of conditions and the following
10-
disclaimer in the documentation and/or other materials provided
11-
with the distribution.
12-
* Neither the name of the copyright holder nor the names of its
13-
contributors may be used to endorse or promote products derived
14-
from this software without specific prior written permission.
4+
modification, are permitted (subject to the limitations in the
5+
disclaimer below) provided that the following conditions are met:
156

16-
THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
7+
* Redistributions of source code must retain the above copyright
8+
notice, this list of conditions and the following disclaimer.
9+
10+
* Redistributions in binary form must reproduce the above
11+
copyright notice, this list of conditions and the following
12+
disclaimer in the documentation and/or other materials provided
13+
with the distribution.
14+
15+
* Neither the name of Qualcomm Technologies, Inc. nor the names of its
16+
contributors may be used to endorse or promote products derived
17+
from this software without specific prior written permission.
18+
19+
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
20+
GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
21+
HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
1722
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18-
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
19-
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
20-
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21-
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22-
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23-
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24-
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25-
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
26-
IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23+
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24+
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
25+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
27+
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28+
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
29+
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30+
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
31+
IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

Lines changed: 8 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,15 @@
1-
**After repository creation:**
2-
- [ ] Update this `README.md`. Update the Project Name, description, and all sections. Remove this checklist.
3-
- [ ] If required, update `LICENSE.txt` and the License section with your project's approved license
4-
- [ ] Search this repo for "REPLACE-ME" and update all instances accordingly
5-
- [ ] Update `CONTRIBUTING.md` as needed
6-
- [ ] Review the workflows in `.github/workflows`, updating as needed. See https://docs.github.com/en/actions for information on what these files do and how they work.
7-
- [ ] Review and update the suggested Issue and PR templates as needed in `.github/ISSUE_TEMPLATE` and `.github/PULL_REQUEST_TEMPLATE`
1+
# qcom-dtb-metadata
82

9-
# Project Name
3+
*qcom-dtb-metadata* project provides a specification document and qcom-metadata.dts file for FIT Based DTB packaging and selection as required by Qualcomm Linux.
104

11-
*\<update with your project name and a short description\>*
5+
## Contribute
126

13-
Project that does ... implemented in ... runs on Qualcomm® *\<processor\>*
7+
With the goal of providing a convenient development environment for upstream
8+
work, please do contribute by opening a Pull Request. Issues can be used to
9+
track issues with the implementation, documentation, and device-specific issues.
1410

15-
## Branches
16-
17-
**main**: Primary development branch. Contributors should develop submissions based on this branch, and submit pull requests to this branch.
18-
19-
## Requirements
20-
21-
List requirements to run the project, how to install them, instructions to use docker container, etc...
22-
23-
## Installation Instructions
24-
25-
How to install the software itself.
26-
27-
## Usage
28-
29-
Describe how to use the project.
30-
31-
## Development
32-
33-
How to develop new features/fixes for the software. Maybe different than "usage". Also provide details on how to contribute via a [CONTRIBUTING.md file](CONTRIBUTING.md).
34-
35-
## Getting in Contact
36-
37-
How to contact maintainers. E.g. GitHub Issues, GitHub Discussions could be indicated for many cases. However a mail list or list of Maintainer e-mails could be shared for other types of discussions. E.g.
38-
39-
* [Report an Issue on GitHub](../../issues)
40-
* [Open a Discussion on GitHub](../../discussions)
41-
* [E-mail us](mailto:[email protected]) for general questions
11+
See [CONTRIBUTING](CONTRIBUTING.md) for more information.
4212

4313
## License
4414

45-
*\<update with your project name and license\>*
46-
47-
*\<REPLACE-ME\>* is licensed under the [BSD-3-clause License](https://spdx.org/licenses/BSD-3-Clause.html). See [LICENSE.txt](LICENSE.txt) for the full license text.
15+
Licensed under [BSD 3-Clause Clear License](LICENSE.txt).

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ How to Report a Potential Vulnerability?
33

44
If you would like to report a public issue (for example, one with a released
55
CVE number), please report it as a
6-
[GitHub issue](https://github.com/qualcomm/REPLACE-ME/issues/new).
6+
[GitHub issue](https://github.com/qualcomm/qcom-dtb-metadata/issues/new).
77
If you have a patch ready, submit it following the same procedure as any
88
other patch as described in [CONTRIBUTING.md](CONTRIBUTING.md).
99

0 commit comments

Comments
 (0)