|
| 1 | +# Contributing to Git Graph |
| 2 | + |
| 3 | +Thank you for taking the time to contribute! |
| 4 | + |
| 5 | +The following are a set of guidelines for contributing to vscode-git-graph. |
| 6 | + |
| 7 | +## Code of Conduct |
| 8 | + |
| 9 | +This project and everyone participating in it is governed by the [Git Graph Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [mhutchie@16right.com](mailto:mhutchie@16right.com). |
| 10 | + |
| 11 | +## How Can I Contribute? |
| 12 | + |
| 13 | +### Reporting Bugs |
| 14 | + |
| 15 | +Raise a bug you've found to help us improve! Due to the extremely broad nature of Git repositories, some bugs might slip through the cracks. |
| 16 | + |
| 17 | +Check the [open bugs](https://github.com/mhutchie/vscode-git-graph/issues?q=is%3Aissue+is%3Aopen+label%3A"bugs"), and bugs ready for release on the [project board](https://github.com/mhutchie/vscode-git-graph/projects/1#column-4514040) to see if it is already in the process of being resolved. If it is, give the issue a thumbs up, and help provide additional context if the issue author was unable to provide some details. |
| 18 | + |
| 19 | +If the bug hasn't previously been reported, please follow these steps: |
| 20 | +1. Raise an issue by selecting the "Bug Report" template on [this page](https://github.com/mhutchie/vscode-git-graph/issues/new/choose). |
| 21 | +2. Follow the template as you see appropriate, it's only meant to be a guide. |
| 22 | +3. Click "Submit new issue" |
| 23 | + |
| 24 | +We aim to respond promptly, and get it resolved as quickly as possible. |
| 25 | + |
| 26 | +### Feature Suggestions |
| 27 | + |
| 28 | +Suggest an idea for this extension! We want to make Git Graph an even more useful tool in Visual Studio Code, so any suggestions you have are greatly appreciated. |
| 29 | + |
| 30 | +Check the [open feature requests](https://github.com/mhutchie/vscode-git-graph/issues?q=is%3Aissue+is%3Aopen+label%3A"feature+request"), and feature requests ready for release on the [project board](https://github.com/mhutchie/vscode-git-graph/projects/1#column-4514040) to see if your idea is already under consideration or on its way. If it is, give the issue a thumbs up so it will be higher prioritsed. |
| 31 | + |
| 32 | +If your feature hasn't previously been suggested, please follow these steps: |
| 33 | +1. Raise an issue by selecting the "Feature Request" template on [this page](https://github.com/mhutchie/vscode-git-graph/issues/new/choose). |
| 34 | +2. Follow the template as you see appropriate, it's only meant to be a guide. |
| 35 | +3. Click "Submit new issue" |
| 36 | + |
| 37 | +We aim to respond promptly, and prioritise it as we and the community see appropriate. |
| 38 | + |
| 39 | +### Contributing To Development |
| 40 | + |
| 41 | +If you're interested in helping contribute, find an open issue you'd like to work on and comment on it. |
| 42 | + |
| 43 | +To set up your development environment, please follow these steps: |
| 44 | +1. Clone the repo |
| 45 | +2. Open the repo in Visual Studio Code |
| 46 | +3. In the terminal, run `npm run install` to download the required dependencies |
| 47 | +4. Install the tslint extension if it is not already installed |
| 48 | +5. Create and checkout a branch for the issue you're going to work on |
| 49 | + |
| 50 | +The npm scripts are as follows: |
| 51 | +`npm run compile` compiles both front and backend code |
| 52 | +`npm run compile-src` compiles the backend code only |
| 53 | +`npm run compile-web` compiles the frontend code only |
| 54 | + |
| 55 | +Raise a pull request once you've completed development, we'll have a look at it. |
| 56 | + |
| 57 | +#### Style Guide |
| 58 | + |
| 59 | +The required style is produced by running "Format Document" in Visual Studio Code. |
0 commit comments