This repository hosts the oneM2M TR-0001 specification defined by oneM2M Partnership project.
Please, contact the rapporteur, RAPPORTEUR_NAME (RAPPORTEUR_EMAIL), if you need any help with this specification/repository.
## Getting started
## Available versions
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
All available baselines produced from this repository are available at [TR-0001 Website](https://specifications.onem2m.org/tr/tr-0001/)(**URL available only if there is at least one baseline**)
Different downloadable formats are available under Download tab
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## How to raise issues
## Add your files
Please report errors, bugs or other issues [here](https://git.onem2m.org/specifications/tr/tr-0001/issues) or [here](https://git.onem2m.org/issues/issues).
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
oneM2M permits the use of Gitlab to manage contributions to this specification.
For more information, visit the [oneM2M Gitlab contribution procedure](https://git.onem2m.org/tools/contribution-procedure).
## Integrate with your tools
## Available tools
-[ ] [Set up project integrations](https://git.onem2m.org/specifications/tr/tr-0001/-/settings/integrations)
A set of tools is used by this repository to facilitate the contribution management:
## Collaborate with your team
- Autogeneration of Word CR documents:
- Upon creation of a Merge Request, a pipeline is executed to produce the associated Word CR documents:
- Main document contains the git diff proposed by the Merge Request.
- Second document contains the tracked changes proposed by the Merge Request. Note that this is for information and it won't be generated anymore in the near future.
- Right after creation of a Merge Request, the source branch needs to be protected in order to avoid any further change to the submitted contribution.
Automated branch protection is disabled for the time being.
**EXTREMELY IMPORTANT TO CHECK THAT SUBMITTED CONTRIBUTION AND MERGE REQUEST CORRESPOND TO THE SAME LAST COMMIT ID**
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- Upon creation of tag, a new version of the spec will be added to the TR-0001 Website and corresponding downloadable documents will also be generated from the markdown specification in this repository
- As Table of Content is not used in the markdown specfication document of this repository, a tool will generate the ToC and add it to the any new published baseline.
## Test and Deploy
Please, refer to [Tools/Scripts repository](https://git.onem2m.org/tools/scripts) for more details.
Use the built-in continuous integration in GitLab.
Some known issues:
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-Generation of Word CR:
- Additions/deletions of images will not appear as tracked change in the Word CR
- Additions/deletions of a list of elements will make the list appearing as not enumerated in the Word CR
- Changes in the first row of a table will break the conversion of such table to Word, the markdown table source code will be seen
- Changes in clause titles will break the conversion of corresponding headings to Word, the markdown heading code will be seen
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
- Protection of the contribution branch
- It needs to be done manually (for the time being) by the Rapporteur of the TR-0001 specification
- If a revision is needed for the contribution, contribution branch needs to be unprotected by the Rapporteur
