Giter Site home page Giter Site logo

sriparno08 / openpedia Goto Github PK

View Code? Open in Web Editor NEW
79.0 3.0 103.0 5.86 MB

Openpedia provides a wealth of useful resources that enable you to become an experienced open source contributor.

Home Page: https://openpedia.netlify.app/

License: MIT License

JavaScript 12.14% HTML 66.18% CSS 21.68%
git beginner-friendly contribute documentation github contribution contributions-welcome first-timers-only good-first-issue guide help-wanted open-source open-source-programs

openpedia's Introduction

Openpedia provides a wealth of useful resources that enable you to become an experienced open source contributor. If you want to leave your mark in the world of open source, this project is a great fit for you.

🧾 Table of Contents

🧐 Introduction to Open Source

This section includes some priceless resources that explain everything that you need to know about open source:

📄 Articles

▶️ Videos

💻 Learn Git and GitHub

This compilation offers some noteworthy resources for learning Git and GitHub, the two most essential tools for contributing to open source:

📄 Articles

▶️ Videos

🙌 Contributing to Open Source

This category comprises a list of useful resources that describe the step-by-step workflow for making open source contributions:

📄 Articles

😇 Beginner-Friendly Repos

This list offers a curated selection of beginner-friendly repos that can get you started as a beginner in open source:

🏅 Open Source Programs

This collection presents a list of open source programs that allow you to upskill and get rewarded for contributing to open source projects:

🌐 Tech Stack

Openpedia is built on these technologies:

HTML5 CSS3 JavaScript NodeJS Webpack

🤝 Contributing

Openpedia is waiting for your contribution!

Here are some interesting ways to contribute to this project:

  • Adding a Resource
  • Improving the Documentation
  • Enhancing the Codebase
  • Upgrading the User Interface
  • Adding a Feature

Please go through the CONTRIBUTING guide for details.

📝 License

Openpedia is licensed under the terms of the MIT License.

openpedia's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

openpedia's Issues

Docs: Update 'Open Source Programs' Description

Category

  • Documentation
  • Resource Addition

Description

We need to change the description under 'Open Source Programs' in README.md by replacing the current markdown with the suggested markdown.

Current Markdown:

There are a lot of open source programs on the internet that allow you to contribute to open source projects.

Here is a list of such initiatives that you can participate in and upskill yourself in open source contributions:

Suggested Markdown:

There are a lot of open source programs on the internet that enable you to get rewarded for contributing to open source projects.

Here is a list of such initiatives that provide an opportunity for you to upskill in open source contributions and get compensated for your hard work:

Docs: Add 'Style Guide for Pull Requests' section in CONTRIBUTING.md

Category

  • Documentation
  • Resource Addition

Description

We need to add a section named 'Style Guide for Pull Requests' in CONTRIBUTING.md and it should be located after the 'Style Guide for Commit Messages' section.

Suggested Markdown:

## Style Guide for Pull Requests

There can be three types of PRs for this repository:

- `Docs`: Changes related to documentation
- `Chore`: Changes related to the codebase, but unrelated to the UI of the website or adding a new feature
- `UI`: Changes related to the UI of the website
- `Feat`: Changes related to adding a new feature

When you are opening a PR, ensure that you are providing the correct type in the PR title in the below format:

```
Docs: Add MDN Web Docs
```

Merge Steps in CONTRIBUTING.md

Merge steps 7 and 8 in 'Making a Pull Request' section in CONTRIBUTING.md.

Current Version:

Step 7: Add a resource to the README.md file
Step 8: Stage changes:

Suggested Version:

Step 7: Modify README.md and stage changes:

Also, modify the next step numbers to support the change.

Change Text in CONTRIBUTING.md

Category

  • Documentation
  • Resource Addition

Description

We need to change 'YouTube Video' to 'Video' in the 'Resources' bulleted list, located under the 'Style Guide for Commit Messages' section in CONTRIBUTING.md.

Docs: Update 'Openpedia' Description in README.md

Category

  • Documentation
  • Resource Addition

Description

We need to change the 'Openpedia' description in README.md by replacing the current markdown with the suggested markdown.

Current Markdown:

This project strives to guide beginners in getting started with open source by providing a wide range of helpful resources. Anyone can jump right in to contribute to this project and make it a reliable source for finding everything related to open source.

Suggested Markdown:

Openpedia offers a large amount of useful resources that enable you to become a seasoned open source contributor. If you are aspiring to leave your imprint in the world of open source, then this project is an excellent fit for you.

Add Issue Template

This repository needs an issue template that will improve the quality of the issues created by the contributors.

Suggestions:

  1. Create a 'Description' header under which contributors will describe the issue
  2. Create a 'Category' header containing two checkboxes named 'Documentation' and 'Resource Addition'
  3. Set the name of the template to ISSUE_TEMPLATE.md

Change 'Category' in PULL_REQUEST_TEMPLATE.md

Category

  • Documentation
  • Resource Addition

Description

We need to change 'Category' in PULL_REQUEST_TEMPLATE.md by replacing the current markdown with the suggested markdown.

Current Markdown:

## Category
<!-- Check the category that applies to this PR by placing an 'x' in the appropriate box. This helps in quickly identifying the type of contribution. -->

- [ ] Article
- [ ] YouTube Video
- [ ] Open Source Program

Suggested Markdown:

## Category

<!-- Type 'x' in the square brackets '[ ]' to check the corresponding category -->

- [ ] Article
- [ ] YouTube Video
- [ ] Beginner-Friendly Repository
- [ ] Open Source Program

Change 'Learn Git and GitHub' Description

Category

  • Documentation
  • Resource Addition

Description

We need to change the description under 'Learn Git and GitHub' in README.md by replacing the current markdown with the suggested markdown.

Current Markdown:

Git and GitHub are two of the most essential tools that you need to master to contribute to open source.

In this section, you will find a list of useful resources that will help you master these essential tools.

Suggested Markdown:

Git and GitHub are two of the most essential tools that you need to master in order to contribute to open source.

These resources provide a substantial amount of information about these tools, allowing you to get a strong hold of them in a short period of time:

Docs: Update 'Style Guide for Pull Requests' in CONTRIBUTING.md

Category

  • Documentation
  • Resource Addition

Description

We need to update 'Style Guide for Pull Requests' in CONTRIBUTING.md by replacing the current markdown with the suggested markdown.

Current Markdown:

There can be three types of PRs for this repository:

Suggested Markdown:

There can be four types of PRs for this repository:

Add Novu

Category

  • Documentation
  • Resource Addition

Description

We need to add 'Novu' under the 'Beginner-Friendly Repos' section in README.md.

Name: Novu
Link: https://github.com/novuhq/novu

Update 'Category' in PULL_REQUEST_TEMPLATE.md

Category

  • Documentation
  • Resource Addition

Description

We need to update the 'Category' section in PULL_REQUEST_TEMPLATE.md by replacing the following markdown:

- [ ] Article
- [ ] YouTube Video
- [ ] Beginner-Friendly Repository
- [ ] Open Source Program

With the suggested markdown:

- [ ] Introduction to Open Source
- [ ] Learn Git and GitHub
- [ ] Contributing to Open Source
- [ ] Beginner-Friendly Repositories
- [ ] Open Source Programs

Change 'Beginner-Friendly Repos' Description

Category

  • Documentation
  • Resource Addition

Description

We need to change the description under 'Beginner-Friendly Repos' in README.md by replacing the current markdown with the suggested markdown.

Current Markdown:

Ready to embark on your open source adventure?

These repos offer a welcoming gateway for newcomers, presenting a curated selection of beginner-friendly issues to help you take your first steps into the world of open source:

Suggested Markdown:

Ready to embark on your open source adventure?

These repos offer a curated selection of beginner-friendly issues that will turn you into a skilled open source contributor:

Change 'Description' in PULL_REQUEST_TEMPLATE.md

Category

  • Documentation
  • Resource Addition

Description

We need to change 'Description' in PULL_REQUEST_TEMPLATE.md by replacing the current markdown with the suggested markdown.

Current Markdown:

## Description
<!-- Please provide a summary of your changes. Include the motivation behind the changes and link to any relevant issues. This section should provide enough information for anyone reviewing your PR to understand what's being changed and why. -->

*Describe your changes here*

Suggested Markdown:

## Description

<!-- Describe the changes made in the PR -->

Add Description Under 'Open Source Programs'

We need to have a description under 'Open Source Programs' to introduce the topic to the readers.

Suggested Description:

There are a lot of open source programs on the internet that allow you to contribute to open source projects.

Here is a list of such initiatives that you can participate in and upskill yourself in open source contributions.

Improve CONTRIBUTING.md

Improve CONTRIBUTING.md by replacing the current markdown with the suggested markdown.

Suggested Markdown:

# Contributing Guidelines

Ready to contribute?

Please go through the guidelines below and make your first contribution:

- [Issues](#issues)
- [Pull Requests](#pull-requests)
- [Making a Pull Request](#making-a-pull-request)
- [Style Guide for Commit Messages](#style-guide-for-commit-messages)

## Issues

- Always create an issue before making a PR.
- Always ensure that there is no other open issue similar to the one that you want to create.
- Always start working on an issue after getting assigned to it.

## Pull Requests

- Each PR should contain a single logical change.
- The PR title should summarize the changes made in it.
- Describe the changes made in the PR to the best of your ability.
- The PR should be linked to the corresponding issue (Closes/Fixes #<issue-number>)

Improve 'Pull Requests' Description in CONTRIBUTING.md

Improve the description of the 'Pull Requests' section in CONTRIBUTING.md.

Current Description:

  • Each PR should contain a single logical change. If a PR becomes too large, it becomes too difficult to review.
  • Try to use your commit message as the title of your PR.

Suggested Description:

  • Each PR should contain a single logical change.
  • The PR title should summarize the changes made in it.

Improve CONTRIBUTING.md

Replace the markdown under 'Style Guide for Commit Messages' in CONTRIBUTING.md with the suggested markdown.

Suggested Markdown:

If you are contributing a resource that refers to any of the first three sections, the commit message would be:

```
git commit -m "Add a/an <resource-type> from <publisher>"
```

Resource Types:

- Article
- YouTube Video

If you are contributing an open source program or a beginner-friendly repository, the commit message would be:

```
git commit -m "Add <name>"
```

Docs: Add 'Tech Stack' Under 'Table of Contents' in README.md

Category

  • Documentation
  • Resource Addition

Description

We need to add ‘Tech Stack’ under ‘Table of Contents’ in README.md.

Suggested Markdown:

- [Introduction to Open Source](#-introduction-to-open-source)
- [Learn Git and GitHub](#-learn-git-and-github)
- [Contributing to Open Source](#-contributing-to-open-source)
- [Beginner-Friendly Repos](#-beginner-friendly-repos)
- [Open Source Programs](#-open-source-programs)
- [Tech Stack](#-tech-stack)
- [Contributing](#-contributing)
- [License](#-license)

Change 'Checklist' in PULL_REQUEST_TEMPLATE.md

Category

  • Documentation
  • Resource Addition

Description

We need to change 'Checklist' in PULL_REQUEST_TEMPLATE.md by replacing the current markdown with the suggested markdown.

Current Markdown:

## Checklist
<!-- Please go through this checklist and confirm before submission. -->

- [ ] I have read the [Contribution Guidelines](https://github.com/Sriparno08/Start-Contributing/blob/main/CONTRIBUTING.md).
- [ ] My changes generate no new warnings or errors.
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] I have added necessary documentation (if appropriate).

Suggested Markdown:

## Checklist

<!-- Type 'x' in the square brackets '[ ]' to check the corresponding criteria -->

- [ ] I have gone through the [CONTRIBUTING](https://github.com/Sriparno08/Start-Contributing/blob/main/CONTRIBUTING.md) guide
- [ ] The name of the resource is correctly spelled (if applicable)
- [ ] The link to the resource is working (if applicable)
- [ ] The resource is added in the correct format (if applicable)

Change 'Introduction to Open Source' Description

Category

  • Documentation
  • Resource Addition

Description

We need to change the description under 'Introduction to Open Source' in README.md by replacing the current markdown with the suggested markdown.

Current Markdown:

Here are some priceless resources that will help answer these questions in detail.

Suggested Markdown:

Here are some priceless resources that will answer these questions in detail:

Update 'Style Guide for Commit Messages' in CONTRIBUTING.md

Category

  • Documentation
  • Resource Addition

Description

We need to update the 'Style Guide for Commit Messages' section in CONTRIBUTING.md by replacing the current markdown with the suggested markdown:

## Style Guide for Commit Messages
  
If the resource belongs to any of these following categories:

- Introduction to Open Source
- Learn Git and GitHub
- Contributing to Open Source

The commit message should be:

```
git commit -m "Add a/an <resource-type> from <publisher>"
```

Resource Types:

- Article
- YouTube Video

If the resource belongs to any of these following categories:

- Beginner-Friendly Repositories
- Open Source Programs

The commit message should be:

```
git commit -m "Add <name>"
```

Fix Documentation in README.md

We need to fix documentation in README.md.

From:

These are many questions that revolve around the world of Open Source.

To:

There are a lot of questions that revolve around the concept of open source.

From:

You need to learn about Git and GitHub to be eligible to contribute to Open Source.

To:

Git and GitHub are two of the most essential tools that you need to master to contribute to open source.

From:

Learning Git and GitHub only makes you half-ready. You need to actually contribute to Open Source to get comfortable with the process.

To:

Learning the essentials is only half of the job done as you need to start contributing to open source to get comfortable with the process.

Update the 'Beginner-Friendly Repos' Description

Category

  • Documentation
  • Resource Addition

Description

We need to update the 'Beginner-Friendly Repos' description by replacing the current markdown with the suggested markdown.

Current Markdown:

Ready to embark on your open source adventure?

These repos offer a welcoming gateway for newcomers, presenting a curated selection of beginner-friendly issues to help you take your first steps into the world of open source.

Here are some of those repos that will give you a head start in open source:

Suggested Markdown:

Ready to embark on your open source adventure?

These repos offer a welcoming gateway for newcomers, presenting a curated selection of beginner-friendly issues to help you take your first steps into the world of open source:

Change 'Related Issue' in PULL_REQUEST_TEMPLATE.md

Category

  • Documentation
  • Resource Addition

Description

We need to change 'Related Issue' in PULL_REQUEST_TEMPLATE.md by replacing the current markdown with the suggested markdown.

Current Markdown:

## Related Issue
<!-- If this PR is related to an issue, please include the issue number here. This helps in tracking and resolving issues efficiently. If there isn't a related issue, you can delete this section. -->

#<issue_number>

Suggested Markdown:

## Related Issue

<!-- Link the PR to the corresponding issue by replacing 'XX' with the issue number -->

Fixes #XX

Add Description Under 'Beginner-Friendly Repositories'

We need to add a description under 'Beginner-Friendly Repositories' to introduce the section to the readers.

Suggested Description:

There are many repositories that enable you to get started with open source by providing a number of beginner-friendly issues.

Here are some of those repositories that will give you a head start in open source:

Add PR Template

This repository needs a PR template that will improve the quality of the PRs made by the contributors.

Suggestions:

  1. Create a 'Description' header under which contributors will describe the changes made in the PR
  2. Create a 'Category' header containing three checkboxes named 'Article', 'YouTube Video' and 'Open Source Program'
  3. Created a 'Related Issue' header under which contributors will link their PR to the corresponding issue
  4. Set the name of the template to PULL_REQUEST_TEMPLATE.md

Change 'YouTube Videos' to 'Videos'

Category

  • Documentation
  • Resource Addition

Description

We need to change 'YouTube Videos' to 'Videos' in these sections:

  • Introduction to Open Source
  • Learn Git and GitHub

Update 'Table of Contents' in README.md

Category

  • Documentation
  • Resource Addition

Description

We need to update 'Table of Contents' in README.md by adding 'Beginner-Friendly Repositories' in between 'Contributing to Open Source' and 'Open Source Programs' in the bulleted list.

Suggested Markdown:

- [Contributing to Open Source](#-contributing-to-open-source)
- [Beginner-Friendly Repositories](#-beginner-friendly-repositories)
- [Open Source Programs](#-open-source-programs)

Change 'Contributing to Open Source' Description

Category

  • Documentation
  • Resource Addition

Description

We need to change the description under 'Contributing to Open Source' in README.md by replacing the current markdown with the suggested markdown.

Current Markdown:

Learning the essentials is only half of the job done as you need to start contributing to open source to get comfortable with the process.

In this section, I have compiled a list of helpful resources that will help you do the same.

Suggested Markdown:

Learning the contribution workflow is a must in your open source journey.

This section compiles a list of useful resources that enable you to get started with open source contributions:

Docs: Add ‘Style Guide for Pull Requests’ Under ‘Table of Contents’ in CONTRIBUTING.md

Category

  • Documentation
  • Resource Addition

Description

We need to add ‘Style Guide for Pull Requests’ under ‘Table of Contents’ in CONTRIBUTING.md.

Suggested Markdown:

- [Issues](#issues)
- [Pull Requests](#pull-requests)
- [Making a Pull Request](#making-a-pull-request)
- [Style Guide for Commit Messages](#style-guide-for-commit-messages)
- [Style Guide for Pull Requests](#style-guide-for-pull-requests)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.