Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ tests/**/Hdr/** gitlab-language=armasm linguist-language=assembly linguist-detec
tests/**/s/** gitlab-language=armasm linguist-language=assembly linguist-detectable=true
tests/**/fth/** gitlab-language=forth linguist-language=forth linguist-detectable=true
tests/**/p/** gitlab-language=prolog linguist-language=prolog linguist-detectable=true
**,fe1 gitlab-language=make linguist-language=makefile
**,fff gitlab-language=text linguist-language=text
VersionNum gitlab-language=c linguist-language=c
**,fe1 gitlab-language=make linguist-language=makefile linguist-detectable=true
**,fff gitlab-language=text linguist-language=text linguist-detectable=true
**,ffb gitlab-language=bbcbasic linguist-language=bbcbasic linguist-detectable=true
VersionNum gitlab-language=c linguist-language=c

36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Question
description: Ask us a question for this repository/project
title: "[Question]: "
labels: [question]
assignees:
- code-reviews-team
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to ask us your question, we'll answer as soon as we have a chance.
- type: input
id: contact
attributes:
label: Contact Details (optional)
description: How can we get in touch with you if we need more info?
placeholder: ex. [email protected]
validations:
required: false
- type: textarea
id: question
attributes:
label: What would you like to ask?
description: type your question in the box below
placeholder: I would like to ask...
value: "I would like to ask..."
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](./CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/requirement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Requirement Report
description: File a requirement report
title: "[Requirement]: "
labels: [requirement, enhancement, feature]
assignees:
- code-reviews-team
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this requirement report!
- type: input
id: contact
attributes:
label: Contact Details (optional)
description: How can we get in touch with you if we need more info?
placeholder: ex. [email protected]
validations:
required: false
- type: textarea
id: user
attributes:
label: As a RISC OS User I would like to
description: Tell us about your requirement from a general user point of view
placeholder: I would like that...
value: "a new feature would be added that does x and y"
validations:
required: false
- type: textarea
id: developer
attributes:
label: As a RISC OS Software Developer I would like to
description: Tell us about your requirement from a software developer point of view
placeholder: I would like that...
value: "a new feature would be added that does x and y"
validations:
required: false
- type: textarea
id: vendor
attributes:
label: As a RISC OS Vendor/Hardware designer I would like to
description: Tell us about your requirement from a vendor point of view
placeholder: I would like that...
value: "a new feature would be added that does x and y"
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](./CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/tasks.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Tasks Report
description: File a tasks report
title: "[Tasks]: "
labels: [enhancement]
assignees:
- code-reviews-team
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this tasks report!
- type: input
id: contact
attributes:
label: Contact Details (optional)
description: How can we get in touch with you if we need more info?
placeholder: ex. [email protected]
validations:
required: false
- type: textarea
id: background
attributes:
label: Background
description: Provide some context for the tasks list
placeholder: Ipsum lorem...
value: "Ipsum lorem..."
validations:
required: true
- type: textarea
id: task-list
attributes:
label: Definition of Done
description: Provide an easy to understand definition of done for each task
placeholder: "- [ ] A"
value: "- [ ] Task A is done when..."
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](./CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ In general you'd want to:

One of the best and most complete C Coding style guide is the Linux Kernel C Coding Style Guide. So, for all general C related coding you should follow such set of rules (learning it can also help you a lot in your Software Engineering career), here is the Linux Coding Style guide for you: [Linux Coding Style Guide](https://www.kernel.org/doc/html/v5.10/process/coding-style.html).

If you are not an experienced C developer and need an easier to read coding manual before getting into the Linux coding style, we recommend to get copy of "The Elements Of C Programming Style" by Jay Ranade and Alan Nash, it's a very good introduction to good C coding style practices and goes from zero to competent C developer on the matter of coding style elements (it doesn't teach you C!).

Given that RISC OS is not linux and has its own ToolBox you shall consider all colliding rules to be superseded by the corresponding rule in the RISC OS Style Guide, here is a link to how to obtain it: [RISC OS Style Guide](https://www.riscosopen.org/wiki/documentation/show/Style%20Guide)

Also please have a look at the Programming Conventions hosted on RISCOS.info, [click here to read them](http://www.riscos.info/index.php/Programming_Conventions)
Expand Down