When I open a project in visual studio code I get this screen:
I want to customize that screen on a per-project basis, so that I can do things like provide links to relevant documentation, describe the project architecture and otherwise communicate to anyone who is collaborating on the project - similar to a MOTD. I'm imagining a .md or .html file in the root directory of my project that is read by VSC as that would also allow my team to provide different landing screens per branch. Does such a thing exist?
I highly recommend using the Settings >> Workbench >> Startup Editor field and setting it to "readme". maintaining a README.md file in any project is a big advantage because most Source Control management sites such as github, gitlab, bitbucket, etc. present this same README on the project overview page.
Related
I'm new to Visual Studio Code. On my projects, I use GitLab project pages to document project process and code.
What is the best way to publish on GitLab pages from the same workspace?
Since I guess we're talking about the Wiki section in GitLab, each Wiki has its own Git repository and therefore should be treated as an individual project, which is, at least regarding the version control, detached from your main project.
This is actually stated in the documentation:
Wikis are based on Git repositories, so you can clone them locally and
edit them like you would do with every other Git repository. To clone
a wiki repository locally, select Clone repository from the right-hand
sidebar of any wiki page, and follow the on-screen instructions.
Files you add to your wiki locally must use one of the following
supported extensions, depending on the markup language you wish to
use. Files with unsupported extensions don’t display when pushed to
GitLab:
Markdown extensions: .mdown, .mkd, .mkdn, .md, .markdown. AsciiDoc
extensions: .adoc, .ad, .asciidoc. Other markup extensions: .textile,
.rdoc, .org, .creole, .wiki, .mediawiki, .rst.
About editing in Visual Studio Code, take a look at the documentation of the Markdown language.
When you've edited your page, simply commit and push your change.
For documentation within your main project (e.g., the readme.md file) simply modify them and also commit and push them. By the way: explanations of source code usually don't belong in the Wiki, but rather in the source code directly in the language's appropriate form (e.g., Javadoc-style comments in Java).
I keep finding piecemeal examples of things that can go into a .github directory on a GitHub repository.
I can see that it is used for GitHub actions and workflow and for Pull request and issue templates, but I can't see a page outlining what you can put in there with ideally some documentation. I also think I've seen a funding example too.
Basically every time I see something you can do there, I think "that's neat I should do that", but other than examples I can't see a way to discover new things other than by example.
Due to the fact that the directory is called .github it seems to defy Google and SO search as well.
On Github, folder .github is just a convention folder used to place Github related stuff inside it. Github handles some of these files even when you place it in root of your project (such as CONTRIBUTING.md, CODE_OF_CONDUCT.md etc). Because Github is constantly bringing in new features, these features are documented on their own, so there is no "all possible files in .github" page. Feel free to place anything that is related to Github specifically inside it.
Some of the most used files in .github folder:
CODE_OF_CONDUCT.md -> How to engage in community and how to behave yourself.
CONTRIBUTING.md -> How to contribute to repo (making pull request, setting development environment...)
LICENSE.md - A software license tells others what they can and can't do with your source code (You should place this at the root of your project since GitHub ignores it in .github folder. You can find this file while browsing other Git hosting services such as GitLab, Bitbucket etc.)
FUNDING.yml -> Supporting a project
ISSUE_TEMPLATE -> Folder that contains a templates of possible issues user can use to open issue (such as if issue is related to documentation, if it's a bug, if user wants new feature etc) P.S. Take a look at tensorflow ISSUE_TEMPLATE
PULL_REQUEST_TEMPLATE.md -> How to make a pull request to project
stale.yml -> Probot configuration to close stale issues. There are many other apps on Github Marketplace that place their configurations inside .github folder because they are related to GitHub specifically.
SECURITY.md -> How to responsibly report a security vulnerability in project
workflows -> Configuration folder containing yaml files for GitHub Actions
CODEOWNERS -> Pull request reviewer rules. More info here.
dependabot.yml -> Configuration options for dependency updates. More info here.
You don't have to create all these files immediately. If there are lot of bugs reported in your project, create ISSUE_TEMPLATE. If several people wants to support you, create FUNDING.yml . You will create more and more files when the need comes.
Github lists all of the files you can use in the documentation page titled Creating a default community health file and the workflows you can add to the .github directory are detailed in the Introduction to GitHub Actions documentation.
Consider I have a git repository hosted in Bitbucket. I have added this reference using following way.
Serttings > Services > External Git
Now when I am going to create a build it is not showing source navigation. But when we use visual studio git it shows source navigation like following
But navigation is missing for external git
Is it known issue or I am missing any configuration that’s why it is not showing source navigation?
That is by design, you just can specify the file manually (relative path and Wildcards can be used, e.g. ConsoleApplication1/ConsoleApplication1.sln).
I submitted a user voice here that you could vote.
The canonical question on 'how to use Git in Visual Studio?' appears to be this one posted by Herb Caudill.
One of the more recent answers notes (correctly) that "Visual Studio 2013 natively supports Git".
So when I go to a Github page (supercolider's is the one I'm trying to clone) and click on the 'Clone in Desktop' button I would expect (hope) that Visual Studio 2013 would take up the link and clone the repository. That is not what happens, instead Windows (I'm using 8.1) asks me if I would like to visit the store to find an app that can handle files of type (github-windows).
What is the correct way to clone a GitHub repository in Windows under Visual Studio 2013? The various MSDN pages (e.g. Share your code in Git or Setup Git on your dev machine) mention GitHub but do not explain how to use it.
It is super easy once you know how :)
From within Visual Studio 2013:
Select File -> Open -> Open From Source Control
The Team Explorer window will come up, one of the sections is "Local GIT repositories". In that section choose "Clone".
That will bring up a path selection textbox and directory browser. Simply replace the default path with the git URL (in your case "https://github.com/supercollider/supercollider")
Thats it!
Note: unless specified otherwise, Visual Studio will store the actual files here:
C:\Users\\Source\Repos\
What you do is go to the Team Explorer, click the Connect to Team Projects, select the Clone option and enter the URL of the Repo you wish to clone and press Clone
To expand on neo12's answer & address the canonical question "how to use Git in Visual Studio"
I agree with neo12. Additionally you can also navigate directly to solutions from the Team Explorer "Local Git Repositories" section by double clicking them
Here is a walk through I put together to explain in concise detail. The video is less than 2 minutes. Let me know if this helps.
http://prestoasp.net/lesson/how-to-work-with-visual-studio-github/
I'm learning to use the TortoiseHG/Workbench. I'm using local repositories with some web server for browsing which comes with the Workbench.
Is there a way to browse the source code while having a source control info displayed next to the list of files in the folder? I'm looking for a code browsing view similar to what "github" or sourceforge provides.
Changing the setting for the web server to github style does not seem to affect the way the project files are displayed.
There are several alternative Mercurial web servers, with more features than the built-in one that you are using:
RhodeCode
demo site
file list with source control info (from demo site)
SCM Manager
screenshots
screenshot of file list with source control info
Both are some kind of "GitHub / Bitbucket for your own server".
Is this what you want?