forked from hyperledger-iroha/iroha-dco
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- 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 <[email protected]>
- Loading branch information
Showing
5 changed files
with
485 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) | ||
| <!-- You will not see HTML commented line in Pull Request body --> | ||
| <!-- Optional sections may be omitted. Just remove them or write None --> | ||
|
|
||
| <!-- ### Requirements --> | ||
| <!-- * Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion. --> | ||
| <!-- * All new code must have code coverage above 70% (https://docs.codecov.io/docs/about-code-coverage). --> | ||
| <!-- * CircleCI builds must be passed. --> | ||
| <!-- * Critical and blocker issues reported by Sorabot must be fixed. --> | ||
| <!-- * Branch must be rebased onto base branch (https://soramitsu.atlassian.net/wiki/spaces/IS/pages/11173889/Rebase+and+merge+guide). --> | ||
|
|
||
|
|
||
| ### Description of the Change | ||
|
|
||
| <!-- We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. --> | ||
| <!-- Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts. --> | ||
|
|
||
| ### Benefits | ||
|
|
||
| <!-- What benefits will be realized by the code change? --> | ||
|
|
||
| ### Possible Drawbacks | ||
|
|
||
| <!-- What are the possible side-effects or negative impacts of the code change? --> | ||
| <!-- If no drawbacks, explicitly mention this (write None) --> | ||
|
|
||
| ### Usage Examples or Tests *[optional]* | ||
|
|
||
| <!-- Point reviewers to the test, code example or documentation which shows usage example of this feature --> | ||
|
|
||
| ### Alternate Designs *[optional]* | ||
|
|
||
| <!-- Explain what other alternates were considered and why the proposed version was selected --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 [email protected] | ||
| * 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 <base-branch> | ||
| ``` | ||
|
|
||
| [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 | [[email protected]](mailto:[email protected]) | | ||
| | Gitter | https://gitter.im/hyperledger-iroha/Lobby | | ||
| | Telegram | https://t.me/joinchat/Al-9jkCZ6eePL9JMQtoOJw | | ||
|
|
||
|
|
||
|
|
||
| --- | ||
|
|
||
| Thank you for reading the document! |
Oops, something went wrong.