Skip to content

Commit

Permalink
[nfc] Add a short list of "style" preferences to CONTRIBUTING. (#66)
Browse files Browse the repository at this point in the history
Mostly wanted to record our preference for wrapping to 80 chars,
but added a few other suggestions too.
  • Loading branch information
dtzSiFive authored Jan 20, 2023
1 parent 51c7f71 commit f177dd3
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Guide for Contributors

## Writing

* Wrap markdown lines to 80 characters.
* Inline FIRRTL code snippets should be tagged as FIRRTL code with `{.firrtl}`.
* This isn't recognized by GitHub, but is used for the PDF generation.
* Match terminology and capitalization preferences used elsewhere by default.
* Don't forget to spell-check!

## Pushing Changes

1. Read the [Versioning Scheme of this
Expand Down

0 comments on commit f177dd3

Please sign in to comment.