https://github.com/open-sauced/100-days-of-oss-template

A journal template to help you keep up with your #100DaysOfOSS work
https://github.com/open-sauced/100-days-of-oss-template

Last synced: 8 months ago
JSON representation

A journal template to help you keep up with your #100DaysOfOSS work

• Host: GitHub
• URL: https://github.com/open-sauced/100-days-of-oss-template
• Owner: open-sauced
• License: mit
• Created: 2023-07-14T15:33:53.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-10T15:46:08.000Z (about 1 year ago)
• Last Synced: 2024-12-30T00:14:26.141Z (9 months ago)
• Size: 16.6 KB
• Stars: 31
• Watchers: 5
• Forks: 21
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 100-days-of-oss-template

A journal template to help you keep up with your #100DaysOfOSS work.

## Instructions

We recommend that you use this template to keep track of your work during the challenge. You can use it as a starting point and customize it to your needs.

You will use Markdown to work on your progress. If you are not familiar with working with Markdown, you can read the docs about [Markdown's basic syntax](https://www.markdownguide.org/basic-syntax/).

You might want to create a new repository for your journal, or you can fork this repository and use it as a starting point. Read more about how to do it in the [Getting Started](#getting-started) section.

## Set a Goal

Before you start, set a goal for yourself. What do you want to accomplish in the next 100 days? What do you want to learn? What do you want to build or be a part of? Declaring that in your README will help you stay focused and motivated and help others understand what you're working on.

## Getting Started

There are a couple of ways to use this template. You can create a new repository using this template or fork this repository. We will walk you through them both.

> ⚠️ Before getting started, always ensure you **work on your changes in your forked repository** and _not directly_ in this repository.

### Creating a New Repository Using This Template

1. Click the green "Use this template" button on the top of this repository.

2. Click the "Create new repository" from the dropdown menu.

3. Fill in the repository name and description (optional). Leave the "Include all branches" checkbox unchecked — you only want the default branch.

4. Click the green "Create repository" button.

5. Follow steps 3-9 in the [Forking This Repository](#forking-this-repository) section below to work on your OSS progress.

### Forking This Repository

1. Fork this repository by clicking the fork button on the top.

2. Clone _your forked repository_ to your local machine.

   - Go to _your forked repository_ on GitHub.

   - Click the "<> Code" button and copy the HTTPS link.

   - In your terminal on your local machine, navigate to the directory where you want this repo to live. Then run this command:

     ```bash

     git clone 

     ```

     Paste the HTTPS link that you've copied. For example:

     ```bash

     git clone https://github.com/username/100-days-of-oss-template.git

     ```

3. Create a new file and name this file anything you want, e.g., `my-oss-journal.md`. This file will be where you update your #100DaysofOSS progress. You can use the template in the `journal.md` file. Copy and paste the template into your progress track file, and customize it to your need.

4. Update the `table-of-contents.md` file by adding the link to the target day in the progress track file.

   ```markdown

   [Day X](file-name.md#day-x)

   ```

   For example:

   ```markdown

   [Day 1](my-oss-journal.md#day-1)

   ```

5. Create a new branch for each challenge day if you want to keep your work separate.

   - In your terminal, run this command:

     ```bash

     git checkout -b 

     ```

     You can name the branch anything, e.g., `day-1`. Then the command will be:

     ```bash

     git checkout -b day-1

     ```

6. Add and commit your work to your branch.

   - In your terminal, run these commands:

     ```bash

     git add .

     git commit -m "Your commit message"

     ```

     Change the "Your commit message" with your message. For example:

     ```bash

     git commit -m "Add day 1"

     ```

7. Push your changes to _your forked repository_.

   - In your terminal, run this command:

     ```bash

     git push -u origin 

     ```

     Change the `your-branch-name` to your current branch name. For example:

     ```bash

     git push -u origin day-1

     ```

8. Create a pull request and merge your changes.

   - Go to _your forked repository_ on GitHub.

   - Click the green "Compare & pull request" button.

   - Modify the title if necessary and write the description of your changes.

   - Create a pull request by clicking the green "Create pull request" button.

   - Merge your changes into the `main` branch by clicking the green "Merge pull request" and the "Confirm merge" button.

9. Repeat steps 5-8 for each day of the challenge.

## Tips for making the most out of #100DaysOfOSS

- Use the `table-of-contents.md` file to keep track of your work.

- Commit your work every day, even if you only have time to work on it for a short time.

- If you don't have time to work on a project, read an article, watch a video, or attend an event about an OSS topic that interests you.

- If you need help, ask for help! You can ask a friend, a mentor, or the community for help.

- If you get bored, try something new! There are so many ways to contribute to OSS. You can write code, documentation, test software, translate content, and more.

- If you get frustrated, take a break. OSS is supposed to be fun! If you're not having fun, take a break and come back to it later.

## Additional Resources

- [#100DaysOfOSS](https://docs.opensauced.pizza/community/100-days-of-oss/)

- [OpenSauced](https://opensauced.pizza/)