| (window.webpackJsonp=window.webpackJsonp||[]).push([[67],{413:function(e,t,s){"use strict";s.r(t);var n=s(11),a=Object(n.a)({},(function(){var e=this,t=e.$createElement,s=e._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"contributing-to-teaclave"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#contributing-to-teaclave"}},[e._v("#")]),e._v(" Contributing to Teaclave")]),e._v(" "),s("p",[e._v("As an open-source community, we welcome all kinds of contributions. You can\ncontribute to Teaclave in many ways: reporting issues, requesting new features,\nproposing better designs, fixing bugs, implementing functions, improving\ndocuments, trying novel research ideas or even by simply using and promoting\nthis project.")]),e._v(" "),s("h2",{attrs:{id:"submit-issues"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#submit-issues"}},[e._v("#")]),e._v(" Submit Issues")]),e._v(" "),s("p",[e._v("We prefer to use GitHub issues for almost everything about the project\ndevelopment such as issues tracking, features, design proposals, announcements,\ncommunity communications, etc. Free feel to open an issue if you meet bugs or\nwant to propose features.")]),e._v(" "),s("h2",{attrs:{id:"send-pull-requests"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#send-pull-requests"}},[e._v("#")]),e._v(" Send Pull Requests")]),e._v(" "),s("p",[e._v("This is a basic instruction to send a pull request to Teaclave.")]),e._v(" "),s("ol",[s("li",[e._v("Fork the repository on GitHub.")]),e._v(" "),s("li",[e._v("Create a new branch for the feature or bugfix.")]),e._v(" "),s("li",[e._v("Make changes.")]),e._v(" "),s("li",[e._v("Test. The "),s("code",[e._v("make run-tests")]),e._v(" command will run all test case.")]),e._v(" "),s("li",[e._v("Make sure to format and lint the code. You can use "),s("code",[e._v("make format")]),e._v(" to format\ncode inplace, and "),s("code",[e._v("make CLI=1")]),e._v(" to lint Rust code with Rust clippy.")]),e._v(" "),s("li",[e._v("Commit/push the changes and send a pull request on GitHub. Please kindly\nwrite some background and details for this PR (we also provide a PR template\nto guild you with writing a high-quality pull request).")])])])}),[],!1,null,null,null);t.default=a.exports}}]); |