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

Update README.md and CONTRIBUTING.md #584

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
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
61 changes: 55 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,61 @@
# Guidlines to contribute
- First of all select the correct category of the code. If you are not sure then add it to HelloWolrd folder.
- After you select the category put it in correct language folder
# Guidlines to Contribute
- First, select the correct category for your code.
- General examples of algorithms or data structures should go in the Algorithms or DS folder.
- Solutions to specific problems from a coding learning platform should go in the folder named after the platform, e.g. LeetCode.
- If you are still unsure where your code should go, place it in the HelloWorld folder.
- Then, read the section below that corresponds to your chosen category.
- Finally, read your destination folder's README for further instruction.

## Algorithms & DS
## Category-specific Guidelines
### Algorithms & DS
- Put the code in correct language folder.
- If the language folder is not there. then write file name as ```lang/file.lang```. This will automatically create new lang folder and put the file in that language's folder.
- For example ```Java/sieve.java```.
- For example ```Java/sieve.java```.

## Problem Solutions
### Problem Solutions
- You can directly add the problem solutions to corresponding platform folder. File name should be the ID of the problem on particular platform.
- If platform folder doesn't exist then write file name as ```Platform/file.lang``` where ```Platform``` is the name of the platform and ```file.lang``` is the name of file.


## How to Contribute
1. **Fork the repository**

Click the "Fork" button at the top right of this repository to create a copy of it in your GitHub account.

2. **Clone the repository**

Clone the new, forked repository onto your local computer using Git.
```
git clone https://github.com/your-username/HacktoberfestForBeginners.git
cd HacktoberfestForBeginners
```

3. **Create a new branch**

Create a new branch to work on your contributions.
```
git checkout -b new-branch-name
```

4. **Make your contributions**

Add your contributions-- usually, a new file-- to the correct folder in the project.

5. **Commit your changes**

Commit your changes to the branch
```
git add .
git commit -m "Create a meaningful commit message"
```

6. **Push to your fork**

Push your local changes to your forked repository on GitHub.
```
git push -u origin new-branch-name
```

7. **Create a Pull Request**

On GitHub, go to your new branch on your forked repository. Select the button to open a new Pull Request, fill out the form, and submit!
31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,27 @@
# HacktoberfestForBeginners
New to Open Source? You can start contributing to this repo.
New to open-source? You can start contributing to this repo.

Check out current issues and contribute to them. You can send as many Pull Requests as you want!
HacktoberfestForBeginners was originally created to provide a beginner-friendly environment to participate in Hacktoberfest. While submissions towards this repo [will not officially count towards Hacktoberfest](https://github.com/vichitr/HacktoberfestForBeginners/issues/331), it is a great starting point for learning the process of contributing to open-source!

## Project Structure

This repo is a collection of examples and solutions to common coding problems. For this reason, you will find that files here are often short and focus on one problem. This helps to make contributing simple.

### Algorithms & DS
These two folders contain examples of common algorithms and data structures, respectively. Each folder is further categorized by language. Some examples of algorithms found in the Algorithms folder include Linear Search, Binary Search, Sorting, Sieve, DP algorithms, etc. Some examples of data structures are mentioned in the README of the DS folder.

## Algorithms & DS
Some of the basic algorithms - Linear Search, Binary Search, Sorting, Sieve, DP algorithms etc. Some of data structures are mentioned in README of DS folder.
### Problem Solutions
The remainder of the repo's folders contain solutions to problems available on learning platforms like Codeforces, Codechef, Hackerrank, Hackerearth, Atcoder, Topcoder, CS Academy, Leetcode, SPOJ, Interviewbit, etc. Each folder name corresponds to its learning platform.

## Guidelines to Contribute
Before contributing, please read and follow the instructions given in [CONTRIBUTING](https://github.com/vichitr/HacktoberfestForBeginners/blob/master/CONTRIBUTING.md).

Check out current issues and contribute to them. You can send as many Pull Requests as you want!

## Problem Solutions
You can also contribute to problem solutions of problems available on various platforms like Codeforces, Codechef, Hackerrank, Hackerearth, Atcoder, Topcoder, CS Academy, Leetcode, SPOJ, Interviewbit etc.
### PS: Do not pick a problem from an ongoing contest.

## Guidelines to contribute
- Read instructions given in [CONTRIBUTING](https://github.com/vichitr/HacktoberfestForBeginners/blob/master/CONTRIBUTING.md).
- Do follow the convention mentioned.
## Code of Conduct
Please follow our [Code of Conduct](https://github.com/vichitr/HacktoberfestForBeginners/blob/master/code-of-conduct.md) to maintain a friendly environment for all contributors.

### PS: Do not pick a problem from an ongoing contest.
## License
This repository is licensed under the [MIT License](https://github.com/vichitr/HacktoberfestForBeginners/blob/master/LICENSE).