CONTRIBUTING.md Outline with lots of TODOs

2020-03-04 17:05:59 -05:00 · 2020-03-04 17:05:59 -05:00 · 52a885de38
commit 52a885de38
parent e032d3d4aa
1 changed files with 31 additions and 0 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -0,0 +1,31 @@
+# Contributing to Rust IPFS
+
+Welcome, and thank you for your interest in contributing to Rust IPFS. Issues and pull requests are encouraged.
+
+## Target Build
+
+Rust IPFS will always target the current _stable_ version of Rust that is released. Our CI/CD tests will reflect this.
+
+TODO: Instructions on installing the up-to-date stable toolchain
+TODO: First Principles
+
+## Roadmap
+
+- Link to roadmap issue or project?
+
+## Contributing
+
+Reporting Bugs
+Suggesting Enhancements
+Your First Code Contribution
+Pull Requests
+
+## TODO: Styleguides
+
+Git Commit Messages
+JavaScript Styleguide
+CoffeeScript Styleguide
+Specs Styleguide
+Documentation Styleguide
+
+## Security vuln disclosure - perhaps in SECURITY.md?