-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the TeamGuruX.com wiki!
This the place where all existing application functionality descriptions can be found.
Issues are a great way to keep track of tasks, enhancements, and bugs of this project. They’re kind of like email—except they can be shared and discussed with the rest of team. Most software projects have a bug tracker of some kind. GitHub’s tracker is called Issues, and has its own section in every repository.
GitHub’s issue tracking is special because of our focus on collaboration, references, and excellent text formatting. A typical issue on GitHub looks a bit like this:
- A title and description describe what the issue is all about.
- Color-coded labels help you categorize and filter your issues (just like labels in email).
- A milestone acts like a container for issues. This is useful for associating issues with specific features or project phases (e.g. Weekly Sprint 9/5-9/16 or Shipping 1.0).
- One assignee is responsible for working on the issue at any given time.
- Comments allow anyone with access to the repository to provide feedback.
To create new issue click New issue button in Issues page.
Read more about issues in Mastering issues article.
Good documentation is key to the success of any project. Making documentation accessible enables people to learn about a project; making it easy to update ensures that documentation stays relevant.
Wiki content is designed to be easily editable. You can add or change content on any wiki page by clicking the Edit button located in the upper right corner of each page. This opens up the wiki editor.
Read more about wiki in Documenting your projects on GitHub article.
Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.
Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.
Read more about formatting and syntax in Mastering Markdown article.