diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md new file mode 100644 index 000000000..eda1667ed --- /dev/null +++ b/.gitlab/merge_request_templates/Default.md @@ -0,0 +1,15 @@ +## Summary + +(Summarize the bug encountered concisely) + +## Changelog + +### Added + +### Changed + +### Fixed + +(Reference to issues, labels, and related merge requests) + +/cc @sriedel @mcavalcante diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..499e9ac42 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,17 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) +and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). + + +## Unreleased + +### Added + +### Changed + +### Fixed + +## 0.1.0 - 2021-03-17 +- Initial release. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..318ecfe0f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contribution Guide + +We are happy to accept pull requests and issues from any contributors. Please +note that we try to maintain a consistent quality standard. For a quick overview +please find some of the most important points below. + +## Quick Overview + +* Keep a clean commit history. This means no merge commits, and no long series + of "fixup" patches (rebase or squash as appropriate). Structure work as a + series of logically ordered, atomic patches. `git rebase -i` is your friend. +* Changes should only be made via pull request, with review. A pull request will + be committed by a "committer" (an account listed in `CODEOWNERS`) once it has + had an explicit positive review. +* Make sure you update the [CHANGELOG](CHANGELOG.md) when submitting a MR. +* When creating your first MR, enter your name in the [CONTRIBUTORS](CONTRIBUTORS.md) + list in alphabetical order. +* When changes are restricted to a specific area, you are recommended to add a + tag to the beginning of the first line of the commit message in square + brackets e.g., "[snitch] Fix bug #157". +* Do not force push. After rebasing, use `--force-with-lease` instead. +* Do not attempt to commit code with a non-Apache (or Solderpad for hardware) + license without discussing first. +* If a relevant bug or tracking issue exists, reference it in the pull request + and commits. + +## Git Considerations + +* Separate subject from body with a blank line +* Limit the subject line to 72 characters +* Capitalize the subject line +* Do not end the subject line with a period +* Use the imperative mood in the subject line +* Use the body to explain what and why vs. how + +For further information please see the excellent +[guide](https://chris.beams.io/posts/git-commit/) by Chris Beams. + +## Code Style + +Consistent code style is important. We try to follow existing style conventions +as much as possible: + +* For RTL we use [lowRISC's SystemVerilog style + guidelines](https://github.com/lowRISC/style-guides/blob/master/VerilogCodingStyle.md). +* For C/C++ we follow [LLVM's style + guide](https://llvm.org/docs/CodingStandards.html), pleas note the + `clang-format` in the projects root. +* For Python code we follow the official [`pep8` style + guide](https://www.python.org/dev/peps/pep-0008/). +* For `yaml` files (such as the `Bender.yml`) we format using `ymlfmt`. + Unfortunately, we do not know whether an official style guide exists. +* Use [EditorConfig](https://editorconfig.org) to format all files correctly. + +Please make sure that any code you submit is adhering to the correct standard. diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 000000000..07d9f65b1 --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,7 @@ +The contributors listed below have certified their MemPool contributions +under the [Contributor's Agreement](https://iis-seafile.ee.ethz.ch/f/80e8166d2e). + +Thanks to all. + +* Joan Mihali +* Sergio Mazzola