mirror of
https://github.com/MunGell/awesome-for-beginners.git
synced 2026-01-26 05:18:12 -08:00
Compare commits
9 Commits
b68a6ce9ba
...
6ccf34d60e
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6ccf34d60e | ||
|
|
b9fd746973 | ||
|
|
aeba4b6c1f | ||
|
|
108c7b10a4 | ||
|
|
35c7ae728b | ||
|
|
5f83071e6e | ||
|
|
b5e6e14219 | ||
|
|
dc8eaa529d | ||
|
|
f0bede9611 |
@@ -1,19 +1,66 @@
|
|||||||
# Contribution Guidelines
|
# Contribution Guidelines 🚀
|
||||||
|
|
||||||
Please ensure that your pull request adheres to the following guidelines:
|
Welcome to the **Awesome First PR Opportunities** project! We're excited that you want to contribute. This guide will help you get started.
|
||||||
|
|
||||||
- Search previous suggestions before making a new one to avoid duplicates.
|
|
||||||
- Ensure your contribution is useful and relevant, with sufficient content and a clear, concise description for each item. Make sure your contribution is useful and relevant before submitting. That implies it has enough content and every item has a good succinct description.
|
|
||||||
- Make an individual pull request for each suggestion.
|
|
||||||
- Only include your suggested repository to `data.json` file, README.md file is generated from it.
|
|
||||||
- New categories or improvements to existing categories are welcome.
|
|
||||||
- Check your spelling and grammar.
|
|
||||||
- Make sure your text editor is set to remove trailing whitespace.
|
|
||||||
- The pull request and commit should be given a meaningful title.
|
|
||||||
- Ensure that you describe your pull request.
|
|
||||||
- If the label does not clearly state its "beginner-friendly" purpose, confirm with the maintainer that it is used for such issues. Include a link to where the maintainer approves this.
|
|
||||||
- Maintainer confirmation is also required in case repository has more than one beginner-friendly-like label (e.g. `low-hanging-fruit` and `up-for-grabs`).
|
|
||||||
- Ensure the contributed repository is actively maintained, has a supportive community, and issues with appropriate labels.
|
|
||||||
- Links must be pointing directly to the repository, no tracking links allowed. This list is not for advertising purposes.
|
|
||||||
|
|
||||||
Thank you for your suggestions!!
|
## Setting Up the Development Environment
|
||||||
|
|
||||||
|
1. **Fork the Project**: Click the "Fork" button at the top right of the repository page to create a copy of the project in your GitHub account.
|
||||||
|
|
||||||
|
2. **Clone Your Fork**:
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/your-username/awesome-for-beginners.git
|
||||||
|
cd awesome-for-beginners
|
||||||
|
|
||||||
|
3. **Install Dependencies**: This project does not require specific dependencies, but make sure you have git installed.
|
||||||
|
|
||||||
|
### Making a Contribution
|
||||||
|
|
||||||
|
1. **Create a Branch:**:
|
||||||
|
```bash
|
||||||
|
git checkout -b your-branch-name
|
||||||
|
|
||||||
|
2. **Make Your Changes**: Add or modify the necessary files.
|
||||||
|
|
||||||
|
3. **Check Your Changes**:
|
||||||
|
```bash
|
||||||
|
git status
|
||||||
|
git diff
|
||||||
|
|
||||||
|
4. **Commit Your Changes**:
|
||||||
|
```bash
|
||||||
|
git add .
|
||||||
|
git commit -m "A clear description of your changes"
|
||||||
|
|
||||||
|
5. **Push Your Changes**:
|
||||||
|
```bash
|
||||||
|
Copy
|
||||||
|
git push origin your-branch-name
|
||||||
|
|
||||||
|
#### Submitting a Pull Request (PR)
|
||||||
|
|
||||||
|
1. Go to the page of your fork on GitHub.
|
||||||
|
|
||||||
|
2. Click on "Compare & pull request".
|
||||||
|
|
||||||
|
3. Fill out the PR form with a clear description of your changes.
|
||||||
|
|
||||||
|
4. Submit the PR and wait for feedback from the maintainers.
|
||||||
|
|
||||||
|
##### Best Practices
|
||||||
|
|
||||||
|
**Follow Coding Conventions**: Ensure your code is clean and well-documented.
|
||||||
|
|
||||||
|
**Avoid Duplicates**: Check if your suggestion has already been proposed.
|
||||||
|
|
||||||
|
**Be Clear and Concise**: Provide a detailed description of your changes.
|
||||||
|
|
||||||
|
###### Reporting an Issue
|
||||||
|
|
||||||
|
If you encounter an issue, open an issue by providing:
|
||||||
|
|
||||||
|
A clear description of the problem.
|
||||||
|
|
||||||
|
Steps to reproduce the issue.
|
||||||
|
|
||||||
|
The expected behavior and the actual behavior.
|
||||||
@@ -194,7 +194,6 @@ If you would like to be guided through how to contribute to a repository on GitH
|
|||||||
- [Reddit Enhancement Suite](https://github.com/honestbleeps/Reddit-Enhancement-Suite) _(label: help-wanted)_ <br> A browser extension to enhance the Reddit browsing experience.
|
- [Reddit Enhancement Suite](https://github.com/honestbleeps/Reddit-Enhancement-Suite) _(label: help-wanted)_ <br> A browser extension to enhance the Reddit browsing experience.
|
||||||
- [Semantic-UI-React](https://github.com/Semantic-Org/Semantic-UI-React) _(label: good first issue)_ <br> The official React integration for Semantic UI.
|
- [Semantic-UI-React](https://github.com/Semantic-Org/Semantic-UI-React) _(label: good first issue)_ <br> The official React integration for Semantic UI.
|
||||||
- [serverless](https://github.com/serverless/serverless) _(label: good first issue)_ <br> The Serverless Framework
|
- [serverless](https://github.com/serverless/serverless) _(label: good first issue)_ <br> The Serverless Framework
|
||||||
- [SirixDB](https://github.com/sirixdb/sirix-svelte-front-end) _(label: good first issue)_ <br> A Svelte/Sapper based web front-end for SirixDB, which is a versioned NoSQL document store (XML and JSON) written in Java.
|
|
||||||
- [Storybook JS](https://github.com/storybookjs/storybook) _(label: good first issue)_ <br> Storybook is a frontend workshop for building UI components and pages in isolation.
|
- [Storybook JS](https://github.com/storybookjs/storybook) _(label: good first issue)_ <br> Storybook is a frontend workshop for building UI components and pages in isolation.
|
||||||
- [stryker](https://github.com/stryker-mutator/stryker) _(label: 👶 Good first issue)_ <br> The JavaScript mutation testing framework
|
- [stryker](https://github.com/stryker-mutator/stryker) _(label: 👶 Good first issue)_ <br> The JavaScript mutation testing framework
|
||||||
- [Superalgos](https://github.com/Superalgos/Superalgos) _(label: good first issue)_ <br> A completely Open Source crypto trading bot rewarding good contributions with the SA(Superalgos)-Token.
|
- [Superalgos](https://github.com/Superalgos/Superalgos) _(label: good first issue)_ <br> A completely Open Source crypto trading bot rewarding good contributions with the SA(Superalgos)-Token.
|
||||||
@@ -363,6 +362,7 @@ If you would like to be guided through how to contribute to a repository on GitH
|
|||||||
- [Amplication](https://github.com/amplication/amplication) _(label: good first issue)_ <br> Amplication is an open-source development tool. It helps you develop quality Node.js applications without spending time on repetitive coding tasks.
|
- [Amplication](https://github.com/amplication/amplication) _(label: good first issue)_ <br> Amplication is an open-source development tool. It helps you develop quality Node.js applications without spending time on repetitive coding tasks.
|
||||||
- [Berry - Active development trunk for Yarn](https://github.com/yarnpkg/berry) _(label: good first issue)_ <br> Fast, reliable, and secure dependency management.
|
- [Berry - Active development trunk for Yarn](https://github.com/yarnpkg/berry) _(label: good first issue)_ <br> Fast, reliable, and secure dependency management.
|
||||||
- [Booster](https://github.com/boostercloud/booster) _(label: good first issue)_ <br> A truly serverless framework, write your code and deploy it in seconds without any server configuration files.
|
- [Booster](https://github.com/boostercloud/booster) _(label: good first issue)_ <br> A truly serverless framework, write your code and deploy it in seconds without any server configuration files.
|
||||||
|
- [Devopness](https://github.com/devopness/devopness) _(label: good first issue)_ <br> Devopness aims to drastically simplify the way we manage cloud applications and multi cloud infrastructure in a secure and productive way.
|
||||||
- [Graphback](https://github.com/aerogear/graphback) _(label: good first issue)_ <br> A CLI and runtime framework to generate a GraphQL API in seconds.
|
- [Graphback](https://github.com/aerogear/graphback) _(label: good first issue)_ <br> A CLI and runtime framework to generate a GraphQL API in seconds.
|
||||||
- [H2O Wave](https://github.com/h2oai/wave) _(label: good first issue)_ <br> Realtime Web Apps and Dashboards framework for Python and R. Suited (not only) for AI audience.
|
- [H2O Wave](https://github.com/h2oai/wave) _(label: good first issue)_ <br> Realtime Web Apps and Dashboards framework for Python and R. Suited (not only) for AI audience.
|
||||||
- [Hasura GraphQL Engine](https://github.com/hasura/graphql-engine) _(label: good first issue)_ <br> Blazing fast, instant realtime GraphQL APIs on Postgres with fine grained access control, also trigger webhooks on database events.
|
- [Hasura GraphQL Engine](https://github.com/hasura/graphql-engine) _(label: good first issue)_ <br> Blazing fast, instant realtime GraphQL APIs on Postgres with fine grained access control, also trigger webhooks on database events.
|
||||||
|
|||||||
18
data.json
18
data.json
@@ -913,15 +913,6 @@
|
|||||||
],
|
],
|
||||||
"description": "Ramda Adjunct is the most popular and most comprehensive set of functional utilities for use with Ramda, providing a variety of useful, well tested functions with excellent documentation."
|
"description": "Ramda Adjunct is the most popular and most comprehensive set of functional utilities for use with Ramda, providing a variety of useful, well tested functions with excellent documentation."
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"name": "SirixDB",
|
|
||||||
"link": "https://github.com/sirixdb/sirix-svelte-front-end",
|
|
||||||
"label": "good first issue",
|
|
||||||
"technologies": [
|
|
||||||
"JavaScript"
|
|
||||||
],
|
|
||||||
"description": "A Svelte/Sapper based web front-end for SirixDB, which is a versioned NoSQL document store (XML and JSON) written in Java."
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"name": "json-editor",
|
"name": "json-editor",
|
||||||
"link": "https://github.com/json-editor/json-editor",
|
"link": "https://github.com/json-editor/json-editor",
|
||||||
@@ -1084,6 +1075,15 @@
|
|||||||
],
|
],
|
||||||
"description": "Component framework that runs at build time, converting your components into highly efficient imperative code that surgically updates the DOM."
|
"description": "Component framework that runs at build time, converting your components into highly efficient imperative code that surgically updates the DOM."
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"name": "Devopness",
|
||||||
|
"link": "https://github.com/devopness/devopness",
|
||||||
|
"label": "good first issue",
|
||||||
|
"technologies": [
|
||||||
|
"TypeScript"
|
||||||
|
],
|
||||||
|
"description": "Devopness aims to drastically simplify the way we manage cloud applications and multi cloud infrastructure in a secure and productive way."
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"name": "Julia Language: Help wanted",
|
"name": "Julia Language: Help wanted",
|
||||||
"link": "https://github.com/JuliaLang/julia",
|
"link": "https://github.com/JuliaLang/julia",
|
||||||
|
|||||||
Reference in New Issue
Block a user