Skip to content

Commit

Permalink
CI-CD-Updates (#58)
Browse files Browse the repository at this point in the history
* Remove exec privileges from c and h files
* Apply Formatting Changes
* Spelling Mistake Fixes
  • Loading branch information
Skptak authored Dec 6, 2023
1 parent 086960f commit 90281cb
Show file tree
Hide file tree
Showing 74 changed files with 2,077 additions and 1,799 deletions.
219 changes: 219 additions & 0 deletions .github/.cSpellWords.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,219 @@
ACDM
ACMD
Adma
AMCD
Appli
ARGMT
ARMA
ARMR
ASSD
Atmel
ATSAM
blocknr
BTST
capitalised
cbmc
CBMC
cbor
CBOR
CCRC
CCRCFAIL
CEATA
CEATAEND
Chrs
CLKCR
CLKEN
clks
CLUS
cmock
Cmock
CMock
CMOCK
CNTR
Comd
coremqtt
coverity
Coverity
Cplt
CPSECURE
CPSM
CREATELFNS
CSDK
cstrntowcs
ctest
DBCKEND
DBLOCKSIZE
DCMAKE
DCMOCK
DCOUNT
DCRC
DCRCE
DCRCFAIL
DCTRL
Defl
DESEL
DESTROYIOMAN
DFREERTOS
DIREC
DMAEN
DNDEBUG
DPSM
DTDIR
DTIMER
DTMODE
DTOE
DUNITY
ECAPS
EMIO
EMMC
ENCMDCOMPL
ENMFILE
evsetup
EXTI
ffconfig
FFERRTAB
FFFUNCTIONTAB
FFMODULETAB
FSEL
fwrev
getpacketid
GPIO
GPIOC
GPIOD
hdma
hdmarx
hdmatx
Hein
Hidd
hsdio
HSMCI
HWFC
hwreset
hwrev
IDEN
ILGL
INSRT
ioman
IRAM
ISEOF
isystem
ITAPCHGWIN
ITAPDLY
ITAPDLYENA
ITAPDLYSEL
lcov
MBURST
MINC
misra
Misra
MISRA
MISRAC
MMCA
MMIO
MQTT
msdelay
msdely
MSMCI
MSWIN
mypy
mytoken
NIEN
NODISK
NOINIT
NOMEDIUM
NSAC
NVIC
oemid
optimise
OPTIMISE
optimised
Optimised
optimising
OTAPDLY
OTAPDLYENA
OTAPDLYSEL
OVRE
OVRWR
PBURST
PCLK
Periph
PERIPH
PFCTRL
PINC
PTABLE
PTBL
PWRCTRL
PWRSAV
PWRUP
pxhandle
pylint
pytest
pyyaml
REGD
Resvd
RPBM
RPMB
Rsvd
RTOSFAT
RWMOD
RWSTART
RWSTOP
RXACT
RXBUFF
RXDAVL
RXFIFOE
RXFIFOF
RXFIFOHF
RXOVERR
SCUGIC
SDCLK
SDCOMBO
sddisk
SDHC
SDHS
SDID
SDIDCOUNT
SDIF
SDIO
SDIOCK
SDIOCLK
SDIOEN
SDIOIT
SDIOSUSPEND
SDMA
SDMMC
SDMMCCLK
SDPS
SDSC
sdtype
SDXC
sinclude
sinit
STBITERR
STBY
SWRST
TAAC
tacc
TFXFIFOHE
Tibosch
tobe
TPASTE
TXACT
TXBUFF
TXDAVL
TXFIFOE
TXFIFOF
TXFIFOHE
TXUNDERR
UNACKED
UNRE
UNSTUFF
utest
VSEL
Walmsley
Wunused
xilffs
XPAR
xsdps
Zynd
ZYNQ
91 changes: 66 additions & 25 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,111 @@
# Contribution guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, code, or
documentation, we welcome our community to be involved in this project.
Thank you for your interest in contributing to our project. Whether it's a bug
report, new feature, code, or documentation, we welcome our community to be
involved in this project.

Please read through this document before submitting any issues or pull requests to ensure we are able to help you and all members of the community as effectively as possible.
Please read through this document before submitting any issues or pull requests
to ensure we are able to help you and all members of the community as
effectively as possible.

## Code of conduct
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
opensource-codeofconduct@amazon.com with any additional questions or comments.

This project has adopted the
[Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
For more information see the
[Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
opensource-codeofconduct@amazon.com with any additional questions or comments.

## Security issue notifications
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.

If you discover a potential security issue in this project we ask that you
notify AWS/Amazon Security via our
[vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/).
Please do **not** create a public github issue.

## Submitting a bugs/feature request

Have a bug to report or feature to request? Follow these steps:
1. Search on the [FreeRTOS Community Support Forums](https://forums.freertos.org/), [FreeRTOS-Plus-FAT issue tracker](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-FAT/issues?utf8=%E2%9C%93&q=is%3Aissue) and [FreeRTOS GitHub issue tracker](https://github.com/FreeRTOS/FreeRTOS/issues?utf8=%E2%9C%93&q=is%3Aissue) to be sure this hasn't been already reported or discussed.
2. If your search turns up empty, create a new topic in the [forums](https://forums.freertos.org/) and work with the community to help clarify issues or refine the idea. Include as many of the details listed below.
3. Once the community has had time to discuss and digest, we welcome you to create an [issue](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-FAT/issues) to report bugs or suggest features.

1. Search on the
[FreeRTOS Community Support Forums](https://forums.freertos.org/),
[FreeRTOS-Plus-FAT issue tracker](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-FAT/issues?utf8=%E2%9C%93&q=is%3Aissue)
and
[FreeRTOS GitHub issue tracker](https://github.com/FreeRTOS/FreeRTOS/issues?utf8=%E2%9C%93&q=is%3Aissue)
to be sure this hasn't been already reported or discussed.
2. If your search turns up empty, create a new topic in the
[forums](https://forums.freertos.org/) and work with the community to help
clarify issues or refine the idea. Include as many of the details listed below.
3. Once the community has had time to discuss and digest, we welcome you to
create an [issue](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-FAT/issues)
to report bugs or suggest features.

When creating a new topic on the forums or filing an issue, please include as many relevant details as possible. Examples include:

* A clear description of the situation — what you observe, what you expect, and your view on how the two differ.
* A clear description of the situation — what you observe, what you expect,
and your view on how the two differ.
* A reproducible test case or sequence of steps.
* The version of our code being used.
* Any modifications you've made relevant to the bug.
* Details of your environment or deployment. Highlight anything unusual.


## Contributing via pull request
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

1. You are working against the latest source on the *master* branch.
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
Contributions via pull requests are much appreciated. Before sending us a pull
request, please ensure that:

1. You are working against the latest source on the *main* branch.
2. You check existing open, and recently merged, pull requests to make sure
someone else hasn't addressed the problem already.
3. You open an issue to discuss any significant work - we would hate for your
time to be wasted.

To send us a pull request, please:

1. Fork the repository.
2. Modify the source; focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
3. Follow the [coding style guide](https://www.freertos.org/FreeRTOS-Coding-Standard-and-Style-Guide.html).
2. Modify the source; focus on the specific change you are contributing.
If you also reformat all the code, it will be hard for us to focus on your
change.
3. Follow the
[coding style guide](https://www.freertos.org/FreeRTOS-Coding-Standard-and-Style-Guide.html).
4. Commit to your fork using clear commit messages.
5. Send us a pull request, answering any default questions in the pull request interface.
NOTE: Please make sure the default option (Allow edits from maintainers) is left checked.
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
GitHub provides additional document on
[forking a repository](https://help.github.com/articles/fork-a-repo/) and
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).

## Coding style
* Please ensure that your code complies to the [FreeRTOS coding style guidelines](https://www.freertos.org/FreeRTOS-Coding-Standard-and-Style-Guide.html).

* Please ensure that your code complies to the
[FreeRTOS coding style guidelines](https://www.freertos.org/FreeRTOS-Coding-Standard-and-Style-Guide.html).

## Getting your pull request merged
All pull requests must be approved by our review team before it can be merged in. We appreciate your patience while pull requests are reviewed. The time it takes to review will depend on complexity and consideration of wider implications.

All pull requests must be approved by our review team before it can be merged
in. We appreciate your patience while pull requests are reviewed. The time it
takes to review will depend on complexity and consideration of wider
implications.

## Finding contributions to work on
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), tackling open 'help wanted' issues is a great place to start.

Looking at the existing issues is a great way to find something to contribute
on. As our projects, by default, use the default GitHub issue labels
(enhancement/ bug/duplicate/help wanted/invalid/question/wontfix), tackling open
'help wanted' issues is a great place to start.

## Licensing
The FreeRTOS-Plus-FAT library is released under the MIT open source license, the text of which can be found [here](https://github.com/FreeRTOS/FreeRTOS-Plus-FAT/blob/master/LICENSE.md)

Additional license files can be found in the folders containing any supplementary libraries licensed by their respective copyright owners where applicable.
The FreeRTOS-Plus-FAT library is released under the MIT open source license,
the text of which can be found
[here](https://github.com/FreeRTOS/Lab-Project-FreeRTOS-FAT/blob/main/LICENSE.md)

Additional license files can be found in the folders containing any
supplementary libraries licensed by their respective copyright owners where
applicable.

We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
We may ask you to sign a
[Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement)
for larger changes.
Loading

0 comments on commit 90281cb

Please sign in to comment.