From 2d27a72ecaece0a71068877b8ffe45ee3702f28d Mon Sep 17 00:00:00 2001 From: Chelsie Johnston Date: Tue, 2 Feb 2021 17:39:53 -0600 Subject: [PATCH] Add information about support requests, feature proposals, and contributing. --- CONTRIBUTING.md | 37 ++++++++++++++++++++++++++----------- README.md | 14 +++++++++++++- 2 files changed, 39 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7080661..ad4248e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,22 +1,37 @@ -# How to contribute +# Contributing, Support, & Feature Proposals Welcome, and thanks for contributing to Mannequin! -## Reporting Bugs +## Support & Feature Proposals -It's very helpful to include the following information when reporting a bug: +### How to Get Support or Report a Bug -* PHP Version +Please use the [issue queue](https://github.com/LastCallMedia/Mannequin/issues) to get support and report bugs, making sure to include the following information: +* PHP version * Mannequin version +* Drupal version (if using) * Extensions you are using -* Console output of any commands that aren't doing what you expected. +* Console output of any commands that aren't doing what you expected -## Pull Requests +### How to Propose a Feature -Pull Requests will be run through a comprehensive suite of automated tests. Please be sure that you include tests for any changes that are possible to test. If you need help writing tests, let us know! +Mannequin is accepting support and feature proposals, which are managed via the [issue queue](https://github.com/LastCallMedia/Mannequin/issues). -Development Setup: ------------------- +In most cases, roadmap/feature request involvement necessitates contribution involvement. + +## Contributing + +### How to Submit a Pull Request + +Anyone can contribute! Check the [issue queue](https://github.com/LastCallMedia/Mannequin/issues) to see what needs work (all pull requests must be represented by a corresponding issue in the issue queue). + +PRs most likely to be merged will be written by contributors who are committed to completing their feature + +### Automated Tests + +Pull Requests are run through a comprehensive suite of automated tests. Please be sure that you include tests for any changes that are possible to test (PRs with insufficient test coverage will not be merged). If you need help writing tests, let us know! + +### Development Setup To work on this project, you need: @@ -30,7 +45,7 @@ In development, there are two servers that need to be started to see your change ```php use LastCall\Mannequin\Core\MannequinConfig; use LastCall\Mannequin\Core\Ui\LocalDevelopmentUi; - + $config = MannequinConfig::create([ 'ui' => new LocalDevelopmentUi('http://127.0.0.1:3000') ]) @@ -41,4 +56,4 @@ In development, there are two servers that need to be started to see your change Deployment/Packaging -------------------- -This repository is split using [splitsh-lite](https://github.com/splitsh/lite) running inside of the [derusse/docker-gitsplit](https://github.com/jderusse/docker-gitsplit) Docker container. Pushes to the master branch, as well as pushes of any tags, will be moved to the downstream repositories. \ No newline at end of file +This repository is split using [splitsh-lite](https://github.com/splitsh/lite) running inside of the [derusse/docker-gitsplit](https://github.com/jderusse/docker-gitsplit) Docker container. Pushes to the master branch, as well as pushes of any tags, will be moved to the downstream repositories. diff --git a/README.md b/README.md index ab0e990..7987596 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ Mannequin Welcome to the main repository for [Mannequin](https://mannequin.io), a component theming tool for the web. This repository is primarily used for development on Mannequin itself - see the "Quick Start" section below if you are here to install Mannequin. +Need support, or want to propose a feature? See [contributing.md](https://github.com/LastCallMedia/Mannequin/blob/master/CONTRIBUTING.md). + Quick Start ----------- @@ -22,4 +24,14 @@ vendor/bin/mannequin start * [Documentation](https://mannequin.io/#GetStarted) * [Extensions](https://mannequin.io/#GetStarted) -* [Report a Bug](https://github.com/LastCallMedia/Mannequin/issues/new) +* [Report a Bug + / Get Support](https://github.com/LastCallMedia/Mannequin/issues/new) + +Contributing +------------ + +Mannequin is open-source and is currently accepting contributions. Last Call Media maintains and contributes to the development of the tool. Interested in contributing to Mannequin? See [contributing.md](https://github.com/LastCallMedia/Mannequin/blob/master/CONTRIBUTING.md). + +### Roadmap +We’re still working on an official roadmap, but for now, please see the “Roadmap” issue label in the [issue queue](https://github.com/LastCallMedia/Mannequin/issues) to get a sense of what maintainers are working on. +