Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Create Documentation for Git and GitHub Usage #203

Closed
devvsakib opened this issue Jul 28, 2024 · 4 comments
Closed

[DOC] Create Documentation for Git and GitHub Usage #203

devvsakib opened this issue Jul 28, 2024 · 4 comments
Assignees
Labels
DOC label for Documents documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed opensource

Comments

@devvsakib
Copy link
Owner

Create Documentation for Git and GitHub Usage

Description:
Please create a Markdown file containing comprehensive documentation for using Git and GitHub. This file should include an overview of common commands, best practices, and troubleshooting tips.

Requirements:

  1. The documentation should be written in Markdown format and saved in the /posts folder.

  2. Ensure the documentation covers the following topics:

    • Basic Git commands (init, clone, add, commit, etc.)
    • Branching and merging strategies
    • Working with remote repositories (fetch, pull, push)
    • Handling merge conflicts
    • Using GitHub for collaboration (forking, pull requests, issues, etc.)
    • Tips for maintaining a clean commit history
  3. Update the index.json file in the /posts folder:

    • Add an entry for the new documentation file, including a title that reflects the content (e.g., "Git and GitHub Usage Guide").

Additional Notes:

  • Please ensure the documentation is clear, concise, and well-structured.
  • Include examples where applicable to illustrate the concepts.

This documentation will be a valuable resource for both new and experienced contributors to the project. Thank you!

@devvsakib devvsakib added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers DOC label for Documents opensource labels Jul 28, 2024
@jump3rhood
Copy link
Contributor

Can you assign this to me? I want to work on this. Will help me get acquainted with contributing.

@devvsakib
Copy link
Owner Author

Hi @jump3rhood , can you give me an estimate time how long it will take?

@jump3rhood
Copy link
Contributor

Hi @devvsaki, working on it. Is it cool if i take 2 days? I want it to be comprehensive.

@devvsakib
Copy link
Owner Author

@jump3rhood sure, no worries. we are working on new resources page, so take your time

jump3rhood added a commit to jump3rhood/github-error-solve that referenced this issue Aug 2, 2024
jump3rhood added a commit to jump3rhood/github-error-solve that referenced this issue Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DOC label for Documents documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed opensource
Projects
None yet
Development

No branches or pull requests

2 participants