From fb6971090864dbaf92a41af2caec606b78c37bf3 Mon Sep 17 00:00:00 2001 From: Pascal Precht Date: Wed, 7 Nov 2018 14:47:03 +0100 Subject: [PATCH] chore: update contributing guide and code of conduct --- CONDE_OF_CONDUCT.md | 15 +++ CONTRIBUTING.md | 260 ++++++++++++++++++++++++++++++++------------ 2 files changed, 207 insertions(+), 68 deletions(-) create mode 100644 CONDE_OF_CONDUCT.md diff --git a/CONDE_OF_CONDUCT.md b/CONDE_OF_CONDUCT.md new file mode 100644 index 000000000..817d26c3a --- /dev/null +++ b/CONDE_OF_CONDUCT.md @@ -0,0 +1,15 @@ +# Contributor Code of Conduct + +## Version 1.0-embark + +As contributors and maintainers of the Embark project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities. + +Communication through any of Embark's channels (GitHub, Gitter, IRC, mailing lists, Google+, Twitter, etc.) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. + +We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the Embark project to do the same. + +If any member of the community violates this code of conduct, the maintainers of the Embark project may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate. + +If you are subject to or witness unacceptable behavior, or have any other concerns, please email us at [embark@status.im](mailto:embark@status.im). + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0af795717..54417a7dd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,92 +1,216 @@ -# Contributing +# Contributing to Embark -When contributing to this repository, please first discuss the change you wish to make via issue, -email, or any other method with the owners of this repository before making a change. +We would love for you to contribute to Embark and help make it even better than it is +today! As a contributor, here are the guidelines we would like you to follow: -Please note we have a code of conduct, please follow it in all your interactions with the project. + - [Code of Conduct](#coc) + - [Question or Problem?](#question) + - [Issues and Bugs](#issue) + - [Feature Requests](#feature) + - [Submission Guidelines](#submit) + - [Coding Rules](#rules) + - [Commit Message Guidelines](#commit) -## Pull Request Process +## Code of Conduct +Help us keep Embark open and inclusive. Please read and follow our [Code of Conduct](./CODE_OF_CONDUCT.md). -1. Ensure any install or build dependencies are removed before the end of the layer when doing a - build. -2. Update the README.md with details of changes to the interface, this includes new environment - variables, exposed ports, useful file locations and container parameters. -3. Increase the version numbers in any examples files and the README.md to the new version that this - Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). -4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you - do not have permission to do that, you may request the second reviewer to merge it for you. +## Got a Question or Problem? -## Code of Conduct +Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [Stack Exchange](https://ethereum.stackexchange.com/search?tab=newest&q=embark) where the questions should be tagged with tag `embark`. -### Our Pledge +Stack Exchange is a much better place to ask questions since: -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. +- there are thousands of people willing to help +- questions and answers stay available for public viewing so your question / answer might help someone else +- Stack Exchange's voting system assures that the best answers are prominently visible. -### Our Standards +To save your and our time, we will systematically close all issues that are requests for general support and redirect people to Stack Exchange. -Examples of behavior that contributes to creating a positive environment -include: +If you would like to chat about the question in real-time, you can reach out via [our gitter channel](https://gitter.im/embark-framework/Lobby). -* 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 +## Found a Bug? +If you find a bug in the source code, you can help us by +[submitting an issue](#submit-issue) to our [GitHub Repository](https://github.com/embark-framework/embark/). Even better, you can +[submit a Pull Request](#submit-pr) with a fix. -Examples of unacceptable behavior by participants include: +## Missing a Feature? +You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub +Repository. If you would like to *implement* a new feature, please submit an issue with +a proposal for your work first, to be sure that we can use it. +Please consider what kind of change it is: -* 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 +* For a **Major Feature**, first open an issue and outline your proposal so that it can be +discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, +and help you to craft the change so that it is successfully accepted into the project. +* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). -### Our Responsibilities +## Submission Guidelines -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. +### Submitting an Issue -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. +Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. + +We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we will systematically ask you to provide steps to reproduce your issue. + +You can file new issues by filling out our [new issue form](https://github.com/embark-framework/embark/issues/new/choose). + +### Submitting a Pull Request (PR) +Before you submit your Pull Request (PR) consider the following guidelines: + +1. Search [GitHub](https://github.com/embark-framework/embark/pulls) for an open or closed PR + that relates to your submission. You don't want to duplicate effort. +1. Fork the embark-framework/embark repo. +1. Make your changes in a new git branch: + + ```shell + git checkout -b my-fix-branch develop + ``` + +1. Create your patch, **including appropriate test cases**. +1. Run the test suite, by running `$ npm run fulltest` and ensure that all tests pass. +1. Commit your changes using a descriptive commit message that follows our + [commit message conventions](#commit). Adherence to these conventions + is necessary because release notes are automatically generated from these messages. + + ```shell + git commit -a + ``` + Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. + +1. Push your branch to GitHub: + + ```shell + git push origin my-fix-branch + ``` + +1. In GitHub, send a pull request to `embark:develop`. +* If we suggest changes then: + * Make the required updates. + * Re-run the test suites to ensure tests are still passing. + * Rebase your branch and force push to your GitHub repository (this will update your Pull Request): + + ```shell + git rebase develop -i + git push -f + ``` + +That's it! Thank you for your contribution! + +#### After your pull request is merged + +After your pull request is merged, you can safely delete your branch and pull the changes +from the main (upstream) repository: + +* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: + + ```shell + git push origin --delete my-fix-branch + ``` + +* Check out the develop branch: + + ```shell + git checkout develop -f + ``` + +* Delete the local branch: + + ```shell + git branch -D my-fix-branch + ``` + +* Update your develop with the latest upstream version: + + ```shell + git pull --ff upstream develop + ``` + +## Coding Rules +To ensure consistency throughout the source code, keep these rules in mind as you are working: + +* All public API methods **must be documented**. + +## Commit Message Guidelines + +We have very precise rules over how our git commit messages can be formatted. This leads to **more +readable messages** that are easy to follow when looking through the **project history**. But also, +we use the git commit messages to **generate the Embark change log**. + +### Commit Message Format +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special +format that includes a **type**, a **scope** and a **subject**: + +``` +(): + + + +