Register
Login
Resources
Docs Blog Datasets Glossary Case Studies Tutorials & Webinars
Product
Data Engine LLMs Platform Enterprise
Pricing Explore
Connect to our Discord channel

README.md 5.0 KB

You have to be logged in to leave a comment. Sign In

How to use Github for the first time

https://guides.github.com/activities/hello-world/

#Main steps to follow:

  1. Create a branch for each task: The main branch should contain only finished and approved work.

  2. Before starting to work, #pull the latest version of that branch to your local repository. Try to do this regularly to always work on an updated version. https://github.com/git-guides/git-pull

  3. Work on that and commit your changes. Use good commit messages.

  4. If you are ready to push your work to the branch (or to show your work so far to your team), open a pull request. This is to let the team know about your changes so they can review and approve them, and pull this latest version to their local repositories. https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request

The same applies to Colab notebooks. It is recommended to push your Colab notebooks as Jupyter notebooks to GitHub for long-term versioning with proper commit messages. This way, others can quickly know what changes were made in this notebook, and all of the work, as well as its history, is centralized. 5. If your changes are approved, another collaborator can merge the pull request into the branch. https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/merging-a-pull-reques 6. Use issues to anything strictly related to the code, possible enhancements, or modularization.

https://guides.github.com/features/issues/ 

GitHub Docs

This repository contains the documentation website code and Markdown source files for docs.github.com.

GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.

In this article:

Contributing

Start contributing right now:

We accept a lot of different contributions, including some that don't require you to write a single line of code.

Click make a contribution from docs

As you're using GitHub Docs, you may find something in an article that you'd like to add to, update, or change. Click on make a contribution to navigate directly to that article in the codebase, so that you can begin making your contribution.

Open an issue

If you've found a problem, you can open an issue using a template.

Solve an issue

If you have a solution to one of the open issues, you will need to fork the repository and submit a pull request using the template that is visible automatically in the pull request body. For more details about this process, please check out Getting Started with Contributing.

Join us in discussions

We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in discussions.

And that's it!

That's how you can get started easily as a member of the GitHub Documentation community. :sparkles:

If you want to know more, or you're making a more complex contribution, check out Getting Started with Contributing.

There are a few more things to know when you're getting started with this repo:

  1. If you're having trouble with your GitHub account, contact Support.
  2. We do not accept pull requests for translated content - see CONTRIBUTING.md for more information.

READMEs

In addition to the README you're reading right now, this repo includes other READMEs that describe the purpose of each subdirectory in more detail:

License

The GitHub product documentation in the assets, content, and data folders are licensed under a CC-BY license.

All other code in this repository is licensed under a MIT license.

When using the GitHub logos, be sure to follow the GitHub logo guidelines.

Tip!

Press p or to see the previous file or, n or to see the next file

Comments

Loading...