Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: porting: add new platform checklist #2014

Merged
merged 2 commits into from Jul 17, 2020
Merged

Conversation

bradjc
Copy link
Contributor

@bradjc bradjc commented Jul 13, 2020

Markdown template for requirements for adding a new platform.

Testing Strategy

Copying it into an open PR.

TODO or Help Wanted

n/a

Documentation Updated

  • Updated the relevant files in /docs, or no updates are required.

Formatting

  • Ran make prepush.

Markdown template for requirements for adding a new platform.
```md
### New Platform Checklist

- [ ] Hardware is widely available.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And a link to acquire the hardware is available in the board README (?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could certainly go into a lot more detail about what we expect: links, rust doc headers, no unwrap, etc., but maybe that gets a little clunky for a PR checklist?

doc/Porting.md Outdated Show resolved Hide resolved
Co-authored-by: Pat Pannuto <pat.pannuto@gmail.com>
@bradjc bradjc merged commit c1dfba8 into master Jul 17, 2020
@bors bors bot deleted the docs-porting-checklist branch July 17, 2020 19:59
Copy link
Member

@ppannuto ppannuto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bors r+

@bors
Copy link
Contributor

bors bot commented Jul 20, 2020

Already running a review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants