Skip to content

Commit

Permalink
docs: add issue templates & contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
gregberge committed Sep 16, 2018
1 parent 9657110 commit 273f473
Show file tree
Hide file tree
Showing 8 changed files with 218 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## 👉 [Please follow one of these issue templates](https://github.com/smooth-code/svgr/issues/new/choose) 👈

<!-- Love SVGR? Please consider supporting our collective: 👉 https://opencollective.com/svgr/donate -->

Note: to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above issue templates.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: 🐛 Bug report
about: Create a report to help us improve
---

<!-- Love SVGR? Please consider supporting our collective: 👉 https://opencollective.com/svgr/donate -->

## 🐛 Bug Report

A clear and concise description of what the bug is.

## To Reproduce

Steps to reproduce the behavior:

## Expected behavior

A clear and concise description of what you expected to happen.

## Link to repl or repo (highly encouraged)

Please provide a minimal repository on GitHub.

Issues without a reproduction link are likely to stall.

## Run `npx envinfo --system --binaries --npmPackages @svgr/core,@svgr/cli,@svgr/webpack,@svgr/rollup --markdown --clipboard`

Paste the results here:

```bash

```
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: 🚀 Feature Proposal
about: Submit a proposal for a new feature
---

<!-- Love SVGR? Please consider supporting our collective: 👉 https://opencollective.com/svgr/donate -->

## 🚀 Feature Proposal

A clear and concise description of what the feature is.

## Motivation

Please outline the motivation for the proposal.

## Example

Please provide an example for how this feature would be used.

## Pitch

Why does this feature belong in the SVGR ecosystem?
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: 💬 Questions / Help
about: If you have questions, please read full readme first
---

<!-- Love SVGR? Please consider supporting our collective: 👉 https://opencollective.com/svgr/donate -->

## 💬 Questions and Help

SVGR project is young, but please before asking your question:

- Read carefully the README of the project
- Search if your answer has already been answered in old issues

After you can submit your question and we will be happy to help you!
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/regression.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: 💥 Regression Report
about: Report unexpected behavior that worked in previous versions
---

<!-- Love SVGR? Please consider supporting our collective: 👉 https://opencollective.com/svgr/donate -->

## 💥 Regression Report

A clear and concise description of what the regression is.

## Last working version

Worked up to version:

Stopped working in version:

## To Reproduce

Steps to reproduce the behavior:

## Expected behavior

A clear and concise description of what you expected to happen.

## Link to repl or repo (highly encouraged)

Please provide a minimal repository on GitHub.

Issues without a reproduction link are likely to stall.

## Run `npx envinfo --system --binaries --npmPackages @svgr/core,@svgr/cli,@svgr/webpack,@svgr/rollup --markdown --clipboard`

Paste the results here:

```bash

```
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!-- Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. The two fields below are mandatory. -->

## Summary

<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? -->

## Test plan

<!-- Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI. -->
3 changes: 3 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Please read carefully the README before asking questions.

<!-- Love SVGR? Please consider supporting our collective: 👉 https://opencollective.com/svgr/donate -->
94 changes: 94 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# How to Contribute

SVGR is a small project, it is widely used but has not a lot of contributors. We're still working out the kinks to make contributing to this project as easy and transparent as possible, but we're not quite there yet. Hopefully this document makes the process for contributing clear and answers some questions that you may have.

## [Code of Conduct](https://github.com/smooth-code/svgr/blob/master/CODE_OF_CONDUCT.md)

We expect project participants to adhere to our Code of Conduct. Please read [the full text](https://github.com/smooth-code/svgr/blob/master/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.

## Open Development

All work on SVGR happens directly on [GitHub](/). Both core team members and external contributors send pull requests which go through the same review process.

### Workflow and Pull Requests

_Before_ submitting a pull request, please make sure the following is done…

1. Fork the repo and create your branch from `master`. A guide on how to fork a repository: https://help.github.com/articles/fork-a-repo/

Open terminal (e.g. Terminal, iTerm, Git Bash or Git Shell) and type:

```sh-session
$ git clone https://github.com/<your_username>/svgr
$ cd svgr
$ git checkout -b my_branch
```

Note: Replace `<your_username>` with your GitHub username

2. SVGR uses [Yarn](https://code.fb.com/web/yarn-a-new-package-manager-for-javascript/) for running development scripts. If you haven't already done so, please [install yarn](https://yarnpkg.com/en/docs/install).

3. Run `yarn install`. On Windows: To install [Yarn](https://yarnpkg.com/en/docs/install#windows-tab) on Windows you may need to download either node.js or Chocolatey<br />

```sh
yarn install
```

To check your version of Yarn and ensure it's installed you can type:

```sh
yarn --version
```

4. If you've added code that should be tested, add tests. You can use watch mode that continuously transforms changed files to make your life easier.

```sh
# in the background
yarn run dev
```

5. If you've changed APIs, update the documentation.

6. Ensure the linting is good via `yarn lint`.

```sh-session
$ yarn lint
```

7. Ensure the test suite passes via `yarn test`.

```sh-session
$ yarn test
```

## Bugs

### Where to Find Known Issues

We will be using GitHub Issues for our public bugs. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new issue, try to make sure your problem doesn't already exist.

### Reporting New Issues

The best way to get your bug fixed is to provide a reduced test case. Please provide a public repository with a runnable example.

## Code Conventions

Please follow the `.prettierrc` in the project.

## Credits

This project exists thanks to all the people who [contribute](CONTRIBUTING.md). <a href="graphs/contributors"><img src="https://opencollective.com/svgr/contributors.svg?width=890&button=false" /></a>

### [Backers](https://opencollective.com/svgr#backer)

Thank you to all our backers! 🙏

<a href="https://opencollective.com/svgr#backers" target="_blank"><img src="https://opencollective.com/svgr/backers.svg?width=890"></a>

### [Sponsors](https://opencollective.com/svgr#sponsor)

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

## License

By contributing to SVGR, you agree that your contributions will be licensed under its MIT license.

0 comments on commit 273f473

Please sign in to comment.