From 964277e0b3d60f0d8d65e9f410b2e516d0d5936e Mon Sep 17 00:00:00 2001 From: "Charles Plant St.Louis" <32653033+CPSTL@users.noreply.github.com> Date: Wed, 19 Dec 2018 15:22:57 -0500 Subject: [PATCH] update contributing.md --- CONTRIBUTING.md | 48 ++++++++++++++++++++++++++++++------------------ 1 file changed, 30 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3dadf0761..fc1a6d701 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,28 @@ -# Contributing Guidelines +# Contributing to Polymath -## Do you have a question? +🎉 First off, thanks for taking the time to contribute! 🎉 + +The following is a set of guidelines for contributing to Polymath-Core. Use your best judgment, and feel free to propose changes to this document in a pull request. + +## Table of Contents + +1. Do you have a question about Polymath's codebase? +2. Please Report bugs! +3. Contributing +4. Code Styleguide +5. Code of Conduct +6. Scope + + +## 1. Do you have a question about Polymath's codebase? [Check out our Gitter](https://gitter.im/PolymathNetwork/Lobby) -See also frequently asked questions tagged with Polymath on Stack Exchange and Reddit. +You can also check out our frequently asked questions tagged with Polymath on Stack Exchange and Reddit. + +For questions about the dApp, please visit our [Zendesk](https://polymath.zendesk.com/hc/en-us) -# Please Report bugs! +# 2. Please Report bugs! Do not open an issue on Github if you think your discovered bug could be a security-relevant vulnerability. In the case of the discovery of high security venerabilities, pleasse email us the issue privately at team@polymath.network. @@ -15,32 +31,28 @@ Otherwise, just create a new issue in our repository and follow the template bel [Issue template to make things easier for you](https://github.com/PolymathNetwork/polymath-core/blob/master/.github/ISSUE_TEMPLATE/feature_request.md) -# Contribute! +# 3. Contributing Process -If you would like to contribute to Polymath-core, please fork it, fix bugs or implement features, and propose a [pull request](https://github.com/PolymathNetwork/polymath-core/blob/master/PULL_REQUEST_TEMPLATE.md) +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. The process to contribute to Polymath-core is the following: -Please, refer to the Coding Guide on our [Developer Portal](https://developers.polymath.network/) for more details about hacking on Polymath. - -# Contributing - -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. +1. To get started, please fork the most recent development branch [here](https://github.com/PolymathNetwork/polymath-core/tree/dev-2.1.0) +2. Fix bugs or implement features. Please make sure to take extra steps to highlight the changes you are implementing by putting comments in your code. +3. Propose a [pull request](https://github.com/PolymathNetwork/polymath-core/blob/master/PULL_REQUEST_TEMPLATE.md) -Please note we have a code of conduct, please follow it in all your interactions with the project. - -# Pull Request Process +Please, refer to the Coding Guide on our [Developer Portal](https://developers.polymath.network/) for more details about hacking on Polymath. -[Template](https://github.com/PolymathNetwork/polymath-core/blob/master/PULL_REQUEST_TEMPLATE.md) +Please note we have a code of conduct, please follow it. -# Code Styleguide +# 4. Code Styleguide The polymath-core repo follows the [Solidity style guide](https://solidity.readthedocs.io/en/v0.4.24/style-guide.html) -# Code of Conduct +# 5. Code of Conduct [Community Standards](https://github.com/PolymathNetwork/polymath-core/blob/master/CODE_OF_CONDUCT.md) 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 feel safe and respected. -# Scope +# 6. Scope This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.