IEEE.org
|
IEEE Xplore Digital Library
|
IEEE Standards
|
IEEE Spectrum
|
More Sites
Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
005 OSCom
Maintainers Manual
Commits
407c4e48
Commit
407c4e48
authored
Oct 12, 2020
by
Joshua Gay
🙀
Browse files
Adds simple readme file example
parent
26f1b409
Changes
1
Hide whitespace changes
Inline
Side-by-side
content/README_simple.md
0 → 100644
View file @
407c4e48
The following README file template provides a simple way to comply with our basic governance document for an individual-run project.
The portions of this document that pertain to governance are the following sections:
*
Security
*
Contributing
*
Leadership
*
License
The remaining sections provide an outline with the common elements of README file.
## Project Name
Succinctly state what this project does.
## Background
You can put a bit more of an elevator pitch here. Depending on the nature of you project you could then
```
javascript
##
-
Provide
a
code
snippet
showing
how
to
use
your
project
##
-
Provide
a
demo
via
animated
gif
or
screenshot
alert
(
'
Hello, world!
'
);
```
## Run
Explain how to deploy, configure, install, and/or run your project, and/or show how to use it.
## Security
If your project is of a nature that security flaws may create vulnerabilities for your users, then you should consider
inserting the IEEE SA Open SECURITY policy provided in the OSCom Maintainers Manual.
## Contribute
### CLA
All contributors to this project must submit (or previously submitted) a valid and applicable
[
Contributor License Agreement
](
https://opensource.ieee.org/community/cla
)
.
### Issue
We request that you follow the GitLab workflow of filing an issue or commenting/contributing to an existing issue.
### Fork and Merge
Once you have submitted an issue, if you wish to make a contribution to this project, please:
1.
Fork the project into your personal userspace
2.
Create a temporary branch (ideally with a similar subject line as the issue)
3.
Develop your code trying to keep it to five or fewer commits (you can merge or squash excessive comments)
4.
Create a merge request
## Leadership
Project lead and maintainer: User Name
<user.name@ieee.org>
## License
Copyright 2020 Project Name Authors
See the LICENSE file distributed with this work for copyright and
licensing information, the AUTHORS file for a list of copyright
holders, and the CONTRIBUTORS file for the list of contributors.
SPDX-License-Identifier: BSD-3-Clause
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment