Skip to content
This repository was archived by the owner on Jun 21, 2023. It is now read-only.

Commit 3595de2

Browse files
committed
Update docs
1 parent b9448f2 commit 3595de2

File tree

2 files changed

+80
-0
lines changed

2 files changed

+80
-0
lines changed

CONTRIBUTING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## Contributing
2+
3+
[fork]: https://github.com/github/VisualStudio/fork
4+
[pr]: https://github.com/github/VisualStudio/compare
5+
6+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
7+
8+
## Submitting a pull request
9+
10+
0. [Fork][] and clone the repository.
11+
0. Create a new branch: `git checkout -b my-branch-name`
12+
0. Make your change, add tests, and make sure the tests still pass
13+
0. Push to your fork and [submit a pull request][pr]
14+
0. Pat your self on the back and wait for your pull request to be reviewed and merged.
15+
16+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
17+
18+
- Follow the existing code's style.
19+
- Write tests.
20+
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
21+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
22+
23+
There are certain areas of the extension that are restricted in what they can do and what dependencies they can have.
24+
25+
- All sections and navigation items in the various Team Explorer areas are instantiated regardless of whether they're shown, so code in these areas needs to be as lazily run as possible.
26+
- Anything in the Team Explorer Home page is extremely restricted in what dependencies it can have. Code in this area needs to be as fast and as minimal as possible.
27+
- Team Explorer content outside the Home page is slightly less restricted, but not by much
28+
- Dialogs and views that don't inherit from TeamExplorer classes are free to use what they need.
29+
30+
## Things to improve in the current version
31+
32+
- Localization
33+
34+
## Roadmap and future feature ideas
35+
36+
- Pull Requests
37+
- Issues
38+
39+
## Resources
40+
41+
- [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
42+
- [Using Pull Requests](https://help.github.com/articles/using-pull-requests/)
43+
- [GitHub Help](https://help.github.com)

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# GitHub Extension for Visual Studio
2+
3+
The GitHub Extension for Visual Studio provides GitHub integration in Visual Studio 2015.
4+
Most of the extension UI lives in the Team Explorer pane, which is available from the View menu.
5+
6+
Official builds of this extension are available at [the official website](https://visualstudio.github.com).
7+
8+
## Build requirements
9+
10+
* Visual Studio 2015
11+
* Visual Studio SDK
12+
13+
## Build
14+
15+
Clone the repository and its submodules in a git GUI client or via the command line:
16+
17+
```
18+
git clone [email protected]:github/VisualStudio
19+
cd VisualStudio
20+
git submodule update --init
21+
```
22+
23+
Open the `GitHubVS.sln` solution with Visual Studio 2015.
24+
To be able to use the GitHub API, you'll need to:
25+
26+
- [Register a new developer application](https://github.com/settings/developers) in your profile.
27+
- Open [src/GitHub.App/Api/ApiClientConfiguration.cs](src/GitHub.App/Api/ApiClientConfiguration.cs) and fill out the clientId/clientSecret fields for your application.
28+
29+
## Contributing
30+
31+
Visit the [Contributor Guidelines](CONTRIBUTING.md) for details.
32+
33+
## Copyright
34+
35+
Copyright 2015 GitHub, Inc.
36+
37+
Licensed under the [MIT License](LICENSE.md)

0 commit comments

Comments
 (0)