Skip to content

Latest commit

 

History

History
90 lines (58 loc) · 3.51 KB

README.md

File metadata and controls

90 lines (58 loc) · 3.51 KB
Raw

Discord

nanoFramework logo

Welcome to the nanoFramework community contributions repository!

This repository contains contributions provided and maintained by nanoFramework community members.

These contributions are NOT supported by the nanoFramework team and any issues must be communicated with the contributor that owns it.

Contributions by category

Drivers

OLED SS1306 display 24LC256 EEPROM ESP8266 serial WiFi

Extensions

GpioController STM32 extensions

Utilities

How do I add my contribution?

The goal is to make it simple and with as little ceremony as possible. Nevertheless we have to keep the standard to a minimum! 😉 If you have a contribution, fork this repo and submit a PR. One of the core team members will give it a quick look and merge it.

Checklist for submitting a contribution

  • Find a section that best fits your contribution and add it there.
  • Give it good naming. Simple, descriptive and concise.
  • Add a readme.md following the provided template (TBD).
  • Tidy your code and files inside the contribution folder.
  • Edit the repo README.md to include the mention and link to your contribution. Make sure you put it under the proper section and that the link to it is correct.
  • Make sure it builds.

I don't want to store my code here

That's fine.

We understand that you want to keep it on your own repo. If that's the case it's OK to add it as Git sub-module that will link to your repo.

Or could it be that you've simply stumbled on a good piece of code and just want to share that. Then you submit a PR with a simple readme.md linking to that external resouce and a brief explanation about it.

Feedback and documentation

For documentation, providing feedback, issues and finding out how to contribute please refer to the Home repo.

When you need to discuss something specific about a community target start by doing so in the support:community-contributions channel in our Discord community or reach out directly to the target owner.

Join our Discord community here.

Credits

The list of contributors to this project can be found at CONTRIBUTORS.

The contributions are owned by the contributor who submited it and credit is due to its creator.

License

Each contribution has it's own license. Please check the respective folder.

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.