https://github.com/bloomberg/oss-template
Open Source Project Template
https://github.com/bloomberg/oss-template
keep template
Last synced: 3 months ago
JSON representation
Open Source Project Template
- Host: GitHub
- URL: https://github.com/bloomberg/oss-template
- Owner: bloomberg
- License: apache-2.0
- Created: 2025-03-01T06:15:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-11-03T17:35:16.000Z (6 months ago)
- Last Synced: 2025-11-03T19:25:08.835Z (6 months ago)
- Topics: keep, template
- Homepage:
- Size: 68.4 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Maintainers: MAINTAINERS.md
Awesome Lists containing this project
README
# Open Source Project Template
[](CHANGELOG.md)
[](https://scorecard.dev/viewer/?uri=github.com/bloomberg/oss-template)
[](https://github.com/marketplace/actions/super-linter)
[](CODE_OF_CONDUCT.md)
## Before You Start
As much as possible, we have tried to provide enough tooling to get you up and
running quickly and with a minimum of effort. This includes sane defaults for
documentation; templates for bug reports, feature requests, and pull requests;
and [GitHub Actions](https://github.com/features/actions) that will
automatically manage stale issues and pull requests. This latter defaults to
labeling issues and pull requests as stale after 60 days of inactivity, and
closing them after 7 additional days of inactivity. These
[defaults](.github/workflows/stale.yml) and more can be configured. For
configuration options, please consult the documentation for the [stale
action](https://github.com/actions/stale).
In trying to keep this template as generic and reusable as possible, there are
some things that were omitted out of necessity and others that need a little
tweaking. Before you begin developing in earnest, there are a few changes that
need to be made:
- [ ] ✅ Select an [OSI-approved license](https://opensource.org/licenses) for
your project. This can easily be achieved through the 'Add File' button on the
GitHub UI, naming the file `LICENSE`, and selecting your desired license from
the provided list.
- [ ] Update the `` placeholder in this file to reflect the name
of the license you selected above.
- [ ] Replace `` in
[`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) with a suitable communication
channel.
- [ ] Change references to `org_name` to the name of the org your repository belongs
to e.g., `bloomberg`:
- [ ] In [`README.md`](README.md)
- [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md)
- [ ] Change references to `repo_name` to the name of your new repository:
- [ ] In [`README.md`](README.md)
- [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md)
- [ ] Update the Release and Lint `README` badges to point to your project URL.
- [ ] Update the links to `CONTRIBUTING.md` to point to your project URL:
- [ ] In
[`.github/ISSUE_TEMPLATE/bug_report.yml`](.github/ISSUE_TEMPLATE/bug_report.yml)
- [ ] In
[`.github/ISSUE_TEMPLATE/feature_request.yml`](.github/ISSUE_TEMPLATE/feature_request.yml)
- [ ] In
[`.github/pull_request_template.md`](.github/pull_request_template.md)
- [ ] Update the `Affected Version` tags in
[`.github/ISSUE_TEMPLATE/bug_report.yml`](.github/ISSUE_TEMPLATE/bug_report.yml)
if applicable.
- [ ] Replace the `` placeholder with the name of your project:
- [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md)
- [ ] In [`SECURITY.md`](SECURITY.md)
- [ ] Add names and contact information for the project maintainers to
[`MAINTAINERS.md`](MAINTAINERS.md).
- [ ] Update the `` placeholder in
[`.github/CODEOWNERS`](.github/CODEOWNERS) as well as the
`` and `` entries.
- [ ] Delete the release placeholder content in [`CHANGELOG.md`](CHANGELOG.md).
We encourage you to [keep a changelog](https://keepachangelog.com/en/1.0.0/).
- [ ] Configure [`.github/dependabot.yml`](.github/dependabot.yml) for your project's
language and tooling dependencies.
- [ ] In [`.github/settings.yml`](.github/settings.yml), update the following fields:
- [ ] `name`: Replace with the repository name for your project
- [ ] `description`: A short, 1-2 sentence description of your project
- [ ] `teams`: Uncomment and update the GitHub team names and permissions as appropriate
- [ ] `branches`: Uncomment and enable branch protection settings for your
project _(please **do not** disable branch protection entirely!)_
- [ ] Replace the generic content in this file with the relevant details about
your project.
- [ ] 🚨 Delete this section of the `README`!
## About The Project
Provide some information about what the project is/does.
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to
install them.
- npm
```sh
npm install npm@latest -g
```
### Installation
1. Clone the repository
```sh
git clone https://github.com/org_name/repo_name.git
```
2. Install npm packages
```sh
npm install
```
## Usage
Use this space to show useful examples of how a project can be used. Additional
screenshots, code examples and demos work well in this space. You may also link
to more resources.
_For more examples, please refer to the [Documentation](https://example.com) or
the [Wiki](https://github.com/org_name/repo_name/wiki)_
## Roadmap
See the [open issues](https://github.com/org_name/repo_name/issues) for a list
of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to
learn, inspire, and create. Any contributions you make are **greatly
appreciated**. For detailed contributing guidelines, please see
[CONTRIBUTING.md](CONTRIBUTING.md)
## License
Distributed under the `` License. See [LICENSE](LICENSE) for more
information.
## Contact
Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email
Project Link:
[https://github.com/org_name/repo_name](https://github.com/org_name/repo_name)
## Acknowledgements
This template was adapted from
[https://github.com/othneildrew/Best-README-Template](https://github.com/othneildrew/Best-README-Template).