diff --git a/.gitlab/issue_templates/Bug Report.md b/.gitlab/issue_templates/Bug Report.md new file mode 100644 index 0000000000000000000000000000000000000000..94335f45936e917cc7d925d24a0c3a798e1652b7 --- /dev/null +++ b/.gitlab/issue_templates/Bug Report.md @@ -0,0 +1,38 @@ +Please read this! + +Before opening a new issue, make sure to [search for keywords in the issues +tracker](https://labs.etsi.org/rep/ttcn3/lang/issues?label_name%5B%5D=type::bug) +and verify the issue you're about to submit isn't a duplicate. + +Please remove this notice if you're confident your issue isn't a duplicate. + +Bellow template is a suggestion for a bug report. Feel free to modify it as you +see fit. + +------ + +### Summary + +Summarize the issue concisely. + + +### Example + +If possible, please create a small example that exhibits the problematic +behaviour. Please use code blocks (```) to format code examples. + +### What is the current *bug* behavior? + +What actually happens. If possible provide involved sections of the standard. + +### What is the expected *correct* behavior? + +What should happen instead. If possible provide involved sections of the standard. + + +### Possible fixes + +If you can, suggest possible fixes. + + +/label ~type::bug diff --git a/.gitlab/issue_templates/Clarification Needed.md b/.gitlab/issue_templates/Clarification Needed.md new file mode 100644 index 0000000000000000000000000000000000000000..55fb7251bd7649d7081888aaba9ef481aa5ad672 --- /dev/null +++ b/.gitlab/issue_templates/Clarification Needed.md @@ -0,0 +1,25 @@ +Please read this! + +Before opening a new issue, make sure to [search for keywords in the issues +tracker](https://labs.etsi.org/rep/ttcn3/lang/issues?label_name%5B%5D=type::clarify) +and verify the issue you're about to submit isn't a duplicate. + +Please remove this notice if you're confident your issue isn't a duplicate. + +Bellow template is a suggestion when a clarification is needed. Feel free to +modify it as you see fit. + +------ + +### Summary + +Summarize the issue concisely. + + +### Description + +Describe what you think is unclear or needs further explanation. If possible +explain why you think it's unclear. + + +/label ~type::clarify diff --git a/.gitlab/issue_templates/Editorial Issue.md b/.gitlab/issue_templates/Editorial Issue.md new file mode 100644 index 0000000000000000000000000000000000000000..8f42c2cf6b6e678adae137a0dabbac55bc529d14 --- /dev/null +++ b/.gitlab/issue_templates/Editorial Issue.md @@ -0,0 +1,19 @@ +Please read this! + +Before opening a new issue, make sure to [search for keywords in the issues +tracker](https://labs.etsi.org/rep/ttcn3/lang/issues?label_name%5B%5D=type::editorial) +and verify the issue you're about to submit isn't a duplicate. + +Please remove this notice if you're confident your issue isn't a duplicate. + +Bellow template is a suggestion for a editorial report. Feel free to modify it as you +see fit. + +------ + +### Description + +What is the editorial issue you found? + + +/label ~type::editorial diff --git a/.gitlab/issue_templates/Feature Proposal.md b/.gitlab/issue_templates/Feature Proposal.md new file mode 100644 index 0000000000000000000000000000000000000000..7bec078fb420c33a1928faf399c8596396ca7de6 --- /dev/null +++ b/.gitlab/issue_templates/Feature Proposal.md @@ -0,0 +1,59 @@ +Please read this! + + +Before opening a new issue, make sure to [search for keywords in the issues +tracker](https://labs.etsi.org/rep/ttcn3/lang/issues?label_name%5B%5D=type::feature) +and verify the issue you're about to submit isn't a duplicate. + +Please remove this notice if you're confident your issue isn't a duplicate. + +Bellow template is a suggestion for a feature proposal. Feel free to modify it as you +see fit. Note: There is no need for a design document at this point. + +------ + +### Summary + +A short summary of the proposal. + + +### Description + +What is the problem the feature will solve? + +Describe the feature informally, as in a classroom setting. So it is easier to +understand what the feature is about for someone who is not familiar. + + +#### Use cases + +Who is this for? Provide one or more use cases. + + +### Examples + +Provide before and after examples of how the feature will be used. Please use +code blocks (```) to format code examples. + + +### Proposal + +Please describe as precisely as possible the change to the language. + + +### How does this feature interact or overlap with existing features? + + +### Would this change make TTCN-3 easier or harder to learn, and why? + + +### Would you consider yourself more a tester or a developer? + + +### Would you consider yourself a novice, intermediate, or experienced in TTCN-3? + + +### What other languages do you have experience with? + + +/label ~"type::feature" diff --git a/README.md b/README.md index 52d0d4250a001c81fe7c25652285ef4365ebcd62..f5a06579551790b8ddc3eb7383af756fe6343771 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,29 @@ -# lang +# TTCN-3 language standard +* the tool should serve us, not the other way round. Reduce overhead/automate +* minimal setup and only grow/complicate when needed + * one repository for planning, issues, standard, conformance-tests + * milestone+issues+labels instead of iterations+epics+... + * the standard itself (first docx, later markdown?) +* document processes to make it easier for newcomers to participate/contribute -## Getting started +* seed for further improvement (markdown, formatting, automatic conformance tests) -To make it easy for you to get started with GitLab, here's a list of recommended next steps. -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)! +## Workflow -## Add your files -- [ ] [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: -``` -cd existing_repo -git remote add origin https://labs.etsi.org/rep/ttcn-3/lang.git -git branch -M main -git push -uf origin main -``` -## Integrate with your tools -- [ ] [Set up project integrations](https://labs.etsi.org/rep/ttcn-3/lang/-/settings/integrations) +* Beguendungen: + * Board dient zum synchronisieren (und ersetzt die Mantis States). Signalisiert wann bereit zum Review, schliessen, ... + * Milestones, sind nciht notwendig, aber hilfreich um zu sehen wie weit wir sind. -## Collaborate with your team +try to be close to previous mantis process without making gitlab complicated. -- [ ] [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) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) +* issue (what templates should I create?) +* board (workflow) -## Test and Deploy -Use the built-in continuous integration in GitLab. - -- [ ] [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) - -*** - -# 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!). Thank you 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.