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

Improve Contribution Guide #1564

Closed
wants to merge 5 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .history/CONTRIBUTING_20250201185351.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Contribution Guidelines

Please ensure that your pull request adheres to the following guidelines:

- 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!!
66 changes: 66 additions & 0 deletions .history/CONTRIBUTING_20250201191517.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Contribution Guidelines 🚀

Welcome to the **Awesome First PR Opportunities** project! We're excited that you want to contribute. This guide will help you get started.


## 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.
51 changes: 51 additions & 0 deletions .history/CONTRIBUTING_20250210185309.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Contribution Guidelines 🚀

Welcome to the **Awesome First PR Opportunities** project! We're excited that you want to contribute. This guide will help you get started.

---

## How to Contribute

### 1. **Edit the `data.json` File Directly on GitHub**
The easiest way to contribute is by editing the `data.json` file directly in your browser. Here's how:

1. Go to the [`data.json` file](https://github.com/MunGell/awesome-for-beginners/blob/main/data.json) in the repository.
2. Click the **"Edit"** button (pencil icon) in the top right corner.
3. Make your changes directly in the browser:
- Copy an existing entry in the file.
- Fill in your own information following the same format.
4. Describe your changes in the commit message.
5. Click **"Propose changes"** to create a new branch and open a Pull Request (PR).

GitHub will guide you through the rest of the process to submit your PR.

---

### 2. **Submitting a Pull Request (PR)**
1. After proposing changes, GitHub will guide you through creating a PR.
2. Fill out the PR form with a clear description of your changes.
3. Submit the PR and wait for feedback from the maintainers.

---

### 3. **Best Practices**
- **Follow the Repository Requirements**: Ensure your contribution adheres to the specific requirements of this repository.
- **Avoid Duplicates**: Check if your suggestion has already been proposed.
- **Be Clear and Concise**: Provide a detailed description of your changes.

---

### 4. **Reporting an Issue**
If you encounter an issue or have a suggestion, open an issue by providing:
- A clear description of the problem or suggestion.
- Steps to reproduce the issue (if applicable).
- The expected behavior and the actual behavior.

---

### 5. **Additional Resources**
For a more comprehensive guide on contributing to open-source projects, check out the [First Contributions](https://github.com/firstcontributions/first-contributions) repository.

---

Thank you for your contribution!
70 changes: 51 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,51 @@
# Contribution Guidelines

Please ensure that your pull request adheres to the following guidelines:

- 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!!
# Contribution Guidelines 🚀

Welcome to the **Awesome First PR Opportunities** project! We're excited that you want to contribute. This guide will help you get started.

---

## How to Contribute

### 1. **Edit the `data.json` File Directly on GitHub**
The easiest way to contribute is by editing the `data.json` file directly in your browser. Here's how:

1. Go to the [`data.json` file](https://github.com/MunGell/awesome-for-beginners/blob/main/data.json) in the repository.
2. Click the **"Edit"** button (pencil icon) in the top right corner.
3. Make your changes directly in the browser:
- Copy an existing entry in the file.
- Fill in your own information following the same format.
4. Describe your changes in the commit message.
5. Click **"Propose changes"** to create a new branch and open a Pull Request (PR).

GitHub will guide you through the rest of the process to submit your PR.

---

### 2. **Submitting a Pull Request (PR)**
1. After proposing changes, GitHub will guide you through creating a PR.
2. Fill out the PR form with a clear description of your changes.
3. Submit the PR and wait for feedback from the maintainers.

---

### 3. **Best Practices**
- **Follow the Repository Requirements**: Ensure your contribution adheres to the specific requirements of this repository.
- **Avoid Duplicates**: Check if your suggestion has already been proposed.
- **Be Clear and Concise**: Provide a detailed description of your changes.

---

### 4. **Reporting an Issue**
If you encounter an issue or have a suggestion, open an issue by providing:
- A clear description of the problem or suggestion.
- Steps to reproduce the issue (if applicable).
- The expected behavior and the actual behavior.

---

### 5. **Additional Resources**
For a more comprehensive guide on contributing to open-source projects, check out the [First Contributions](https://github.com/firstcontributions/first-contributions) repository.

---

Thank you for your contribution!