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

Contributing guide add #26

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from 2 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
95 changes: 95 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# 🤔 How to Contribute ?

shivam-sharma7 marked this conversation as resolved.
Show resolved Hide resolved
### 1.) Fork The Repo

Click on **Fork** button present on the upper-right area of the screen to create a copy of this repository to your GitHub account.
[fork](https://github.com/kubesimplify/website)


### 2.) Clone The Repo
-> You can clone this branch to your machine by using the below command.

```bash

git clone -b development https://github.com/<YOUR_USERNAME>/website-1.git

```

-> Navigate to your repo

```bash

cd website-1

```

-> Install dependencies

```bash

npm install

```

### 3.) Setup Remote

```bash

git remote add upstream https://github.com/kubesimplify/website.git

```
To verify
```bash

git remote -v

```
You will get output similar to this
```bash

origin https://github.com/<YOUR_USERNAME>/website-1.git (fetch)
origin https://github.com/<YOUR_USERNAME>/website-1.git (push)
upstream https://github.com/kubesimplify/website.git (fetch)
upstream https://github.com/kubesimplify/website.git (push)

```

### 4.) Contributing & PR

1. Create a new branch.

```
git checkout -b <your_branch_name>
```

2. Perform your desired changes to the code base.

Make sure to run ```npm run format ```

3. Track your changes:heavy_check_mark: .

```
git add .
```

4. Commit your changes
```
git commit -m "Relevant message"
```

5. Push the committed changes in your feature branch to your remote repo.

```
git push -u origin <your_branch_name>
```

5. To create a pull request, click on `compare and pull requests`. Please ensure that you compare your feature branch to the desired branch `development` of the repo to make a PR (Pull request).


6. Add an appropriate title and description to your pull request explaining your changes and efforts done. And edit the PR template

7. Click on `Create Pull Request`.


## PR Review
Your PR will get reviewed soon from the maintainers of the project. If they suggest changes, do all the changes, commit the changes, rebase the branch, squash the commits and push the changes. If everything looks good, your PR will be merged. That's it! Thank you for your contribution! Feel free to suggest any changes to this documentation.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
# Website
This repo is work in progress for the official website of **[Kubesimplify](https://kubesimplify.github.io/website/)**

👨‍💻 Contributing
Contributions make the open source community such an amazing place to learn, inspire, and create.
Any contributions you make are greatly appreciated.
Check out our [Contribution Guidelines](CONTRIBUTING.md) for more information.