From 570dc95ded168d4af3cb42ef485245e4734f5d3f Mon Sep 17 00:00:00 2001 From: Bogdan Vaneev Date: Fri, 15 Dec 2017 18:50:51 +0900 Subject: [PATCH] Documentation improvements - enhance PR template - add github changelog generator - add code of conduct - enhance contributing.md - add apache 2 license full text Signed-off-by: Bogdan Vaneev --- .github/PULL_REQUEST_TEMPLATE.md | 54 +++++--- .github_changelog_generator | 8 ++ CODE_OF_CONDUCT.md | 46 +++++++ CONTRIBUTING.md | 228 +++++++++++++++++++++++++++---- LICENSE | 209 ++++++++++++++++++++++++++-- 5 files changed, 485 insertions(+), 60 deletions(-) create mode 100644 .github_changelog_generator create mode 100644 CODE_OF_CONDUCT.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ce1798ffad..e9d18c35c4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,22 +1,32 @@ -Thanks for the pull request! -Pull requests should have these details: - -## What is this pull request? -Describe simply what this pull request is about. - -## Why do you implement it? Why do we need this pull request? -Describe features, what this pull request resolves, and reasons for this pull request. - -## How to use the features provided in the pull request? -Do you provide tests, or use case examples? -Describe how to use features in your pull request. - -## Details/Features -List of features / major commits -- Add ** to ** -- Remove ** from ** -... - -## Additional dependencies (optional) - -## P.S. (optional) + + + + + + + + + + + +### Description of the Change + + + + +### Benefits + + + +### Possible Drawbacks + + + + +### Usage Examples or Tests *[optional]* + + + +### Alternate Designs *[optional]* + + diff --git a/.github_changelog_generator b/.github_changelog_generator new file mode 100644 index 0000000000..65d0b7cec1 --- /dev/null +++ b/.github_changelog_generator @@ -0,0 +1,8 @@ +# use https://github.com/skywinder/github-changelog-generator to generate a changelog +unreleased=false +issues-wo-labels=false +pr-wo-labels=false +exclude-labels=candidate-for-closing,status:in-progress,status:active,status:inactive,needs-review,needs-correction,question,status:wontfix +bug-labels=bug +enhancement-labels=enhancement +issue-line-labels=true diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..f0b1f3dcde --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team [here](./CONTRIBUTING.md/?#contact-developers). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 10d596d1cb..dbe3b132c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,44 +1,216 @@ # Contributing guidelines -To contribute, please follow this process: +:star::tada: First off, thanks for taking the time to contribute! :tada::star: -## 1. Sign CLA agreement -Please sign it via GitHub credentials: -[Developer Certificate of Origin Version 1.1](https://cla-assistant.io/hyperledger/iroha) +The following is a short set of guidelines for contributing to Iroha. -## 2. Read Iroha working agreement -[Iroha working agreement](https://github.com/hyperledger/iroha/wiki/Iroha-working-agreement) -## 3. Talk to us -Before writing any code, please discuss your intention with us, so that we can help you with your solution. It can also help to reduce situations with duplicated effort. - -Do anything that is more convenient to you: -* Join [Hyperledger RocketChat](https://chat.hyperledger.org/) #iroha channel -* Open new issue in GitHub or discuss existing issue -* Join telegram [Iroha chat](https://t.me/joinchat/AgzrTUCZ6efra09wz35oww) -* Use mailing list to discuss hyperledger-iroha@lists.hyperledger.org -* Communicate in [Gitter chat](https://gitter.im/hyperledger-iroha/Lobby) with our development community +#### Table Of Contents -## 4. Check codestyle +##### [How Can I Contribute?](#how-can-i-contribute-1) -Take a look briefly at [CppCoreGuidelines](https://github.com/isocpp/CppCoreGuidelines) and use [clang-format](https://github.com/hyperledger/iroha/blob/master/.clang-format) to check your code style before creating pull request. +- [Reporting bugs](#reporting-bugs) +- [Suggesting Enhancements](#suggesting-enhancements) +- [Asking Questions](#asking-questions) +- [Your First Code Contribution](#your-first-code-contribution) +- [Pull Requests](#pull-requests) -## 5. Get acquainted with design +##### [Styleguides](#styleguides-1) -As you are going to discuss your change in prior, we will help you to understand design of the system. Please, check architecture section to understand responsibilities of components and interfaces. +- [Git Commit Messages](#git-commit-messages) +- [C++ StyleGuide](#C++-styleguide) +- [Documentation Styleguide](#documentation-styleguide) -## 6. Test your code +##### [Additional Notes](#additional-notes) -Please, follow test policy for the code you write. New code should be covered by at least 80% (see coverage reports in pull requests). +- [Informational Labels](#informational-labels) +- [Pull Request and Issue Labels](#pull-request-and-issue-labels) +- [Issue Labels](#issue-labels) +- [Pull Request Labels](#pull-request-labels) +- [Contact Developers](#contact-developers) -## 7. Create pull request -Follow gitflow approach to create a branch for your code: -* feature/whatever-feature-you-implement, create a branch from develop -* fix/whatever-you-fix-in-develop -* hotfix/whatever-you-fix-in-master -Follow the flow in Iroha working agreement. +## How Can I Contribute? -Thank you for your interest to Iroha project! +### Reporting bugs + +*Bug* is an error, design flaw, failure or fault in Iroha that causes it to produce an incorrect or unexpected result, or to behave in unintended ways. + +Bugs are tracked as [GitHub Issues](https://guides.github.com/features/issues/). To submit a bug, create new Issue and include these details: +- **Title** + - Write prefix `[Bug]` for the title + - Use a clear and descriptive title +- **Body** - include the following sections: + - System environment (OS, iroha version) + - Steps to reproduce + - Expected behavior + - Actual behavior + + + +### Suggesting Enhancements + +An *enhancement* is a code or idea, which makes **existing** code or design faster, more stable, portable, secure or better in any other way. + +Enhancements are tracked as [GitHub Issues](https://guides.github.com/features/issues/). To submit new enhancement, create new Issue and incllude these details: + +- **Title** + - Write prefix `[Enhancement]` + - Use a clear and descriptive title +- **Body** - include the following sections: + - *Target* - what is going to be improved? + - *Motivation* - why do we need it? + - *Description* - how to implement it? + + + +### Asking Questions + +A *question* is any discussion that is typically neigher a bug, nor feature request, nor improvement - "How do I do X?". + +Questions are tracked as [Github Issues](https://guides.github.com/features/issues/) or via private messages in [your favourite messenger](#contact-developers). + +To submit new question in GitHub Issues, it must include these details: + +- **Title** + - Write prefix `[Question]` + - Use a clear and descriptive title +- **Body** - describe your question with as many details as possible. + + + +### Your First Code Contribution + +Read our [C++ Style Guide](#c++-style-guide) and start with beginner-friendly issues with label [`[good-first-issue]`](https://github.com/hyperledger/iroha/issues?q=is:open+is:issue+label:good-first-issue ). Indicate somehow that you are working on this task. + + + +### Pull Requests + +- Fill in [the required template](.github/PULL_REQUEST_TEMPLATE.md) + +- **Write tests** for new code. Test coverage for new code must be at least 70%. + +- Every pull request should be reviewed and **get at least two approvals**. + +- Do not include issue numbers in the PR title or commit messages. + +- Use [keywords for closing issues](https://help.github.com/articles/closing-issues-using-keywords/). + +- Include issue numbers in Pull Request body only. + +- When finished work, **rebase onto base branch** with + ```bash + $ git fetch + $ git rebase -i + ``` + + [Step-by-step guide](https://soramitsu.atlassian.net/wiki/spaces/IS/pages/11173889/Rebase+and+merge+guide). + +- Follow the [C++ Style Guide](#C++-style-guide). + +- Follow the [Git Style Guide](#git-commit-messages) . + +- **Document new code** based on the [Documentation Styleguide](#documentation-styleguide) + +- End all files with a newline. + + + + +## Styleguides + +### Git Style Guide + +- **Use present tense** ("Add feature", not "Added feature"). +- **Use imperative mood** ("Deploy docker to..." not "Deploys docker to..."). +- Write meaningful commit message. +- **Signed-off every commit** with [DCO](https://github.com/apps/dco): `Signed-off-by: $NAME <$EMAIL>`. + You can do it automatically using `git commit -s`. +- Do not include PR or Issue number in commit message. +- Limit the first line of commit message to 50 characters or less. +- First line of commit message must contain summary of work done, second line must contain empty line, third and other lines can contain list of commit changes. +- When only changing documentation, include `[ci skip]` in the commit description. +- We use mixed approach of [Github Flow](https://guides.github.com/introduction/flow/) and [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/). More at [Iroha Working Agreement](https://github.com/hyperledger/iroha/wiki/Iroha-working-agreement#2-version-control-system). + + + + +### C++ Style Guide + +- Use [clang-format](http://clang.llvm.org/docs/ClangFormat.html) for code formatting (we use google code style). +- Follow [CppCoreGuidelines](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) and [Cpp Best Practices](https://lefticus.gitbooks.io/cpp-best-practices). +- Avoid [platform-dependent](https://stackoverflow.com/questions/1558194/learning-and-cross-platform-development-c) code. +- Use [C++14](https://en.wikipedia.org/wiki/C%2B%2B14). +- Use [camelCase](https://en.wikipedia.org/wiki/Camel_case) for class names and methods, use [snake_case](https://en.wikipedia.org/wiki/Snake_case) for variables. + + + +### Documentation Styleguide + +- Use [Doxygen](http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html). +- Document all public API: methods, functions, members, templates, classes... + + +## Additional Notes + +### Informational Labels +| Label Name | Description | +| :---------------------- | ---------------------------------------------------------------- | +| `pri:low` | Low priority. | +| `pri:normal` | Normal priority. | +| `pri:important` | Important issue. | +| `pri:critical` | Critical issue. Must be fixed immediately. | +| `pri:blocker` | Issue blocked by other issues. | +| `status:in-progress` | Work in progress. | +| `status:inactive` | Inactive PR or Issue. Likely to become a `candidate-for-closing` | +| `status:wontfix` | Core team has decided not to fix these issue for now. | + +### Issue and Pull Request labels + +| Label Name | Description | +| :---------------------- | ------------------------------------------------------------ | +| `enhancement:code` | Any improvements in **existing** code. | +| `enhancement:idea` | Fresh ideas to enhance existing architecture, design. | +| `bug:needs-reproduction`| Bugs or reports that are very likely to be bugs. | +| `bug:confirmed` | Confirmed bug by maintainers. | +| `feature` | Feature requests -- completely new functionality. | +| `accepted` | Pull request is accepted and can be merged. | +| `candidate-for-closing` | Outdated Pull Request / Issue. Lasts for more than 14 days. | +| `needs-correction` | Pull Request / Issue that should be corrected by author. | +| `needs-review` | Pull Request / Issue that should be reviewed by maintainer. | + + +### Issue Labels + +| Label Name | Description | +| :---------------------- | --------------------------------------------------------------------- | +| `question` | Questions more than bug reports or feature requests - "How do I do X" | +| `good-first-issue` | Good starting point to begin contributing. | +| `help-wanted` | Maintainers ask for help to work on this issue. | + +### Pull Request Labels + +| Label Name | Description | +| :---------------------- | ------------------------------------------- | +| `accepted` | Pull request is accepted and can be merged. | + + +### Contact Developers + +Developers are available at: + +| Service | Link | +| ------------ | ---------------------------------------- | +| RocketChat | https://chat.hyperledger.org/channel/iroha | +| Mailing List | [hyperledger-iroha@lists.hyperledger.org](mailto:hyperledger-iroha@lists.hyperledger.org) | +| Gitter | https://gitter.im/hyperledger-iroha/Lobby | +| Telegram | https://t.me/joinchat/Al-9jkCZ6eePL9JMQtoOJw | + + + +--- + +Thank you for reading the document! diff --git a/LICENSE b/LICENSE index 56b60cf615..857e425343 100644 --- a/LICENSE +++ b/LICENSE @@ -1,13 +1,202 @@ -Copyright 2016 Soramitsu Co., Ltd. -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ - http://www.apache.org/licenses/LICENSE-2.0 + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2017 Soramitsu LLC + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file