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

Adding Contribution guidelines #9

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
63 changes: 63 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@


# Contributing to Codeuino

🎉 First off, thanks for taking the time to contribute! This project would not be possible without people like you. 🎉

## How Can I Contribute?


#### Project requirements

- [NodeJS](https://nodejs.org) (v8.10 or higher)
- [npm](https://www.npmjs.com) (v4 or higher)
- [yarn](https://yarnpkg.com) (v1 or higher)

#### Local setup

### Installing depencencies and running the app
You should have `node` installed in your system.
* Fork the repository

* Clone the repository
`git clone https://github.com/<username>/website-www.codeuino.org.git`
where \< username \> is your username

* Install create-react-app
`npm install -g create-react-app`

* `cd website-www.codeuino.org`

* `npm install`

* `npm start`


This will:
1. Install all JavaScript dependencies.

You can then access the website at [http://localhost:3000](http://localhost:3000).



## Submitting an Issue

Did you notice a bug? Do you have a feature request? Please file an issue [here on GitHub](https://github.com/codeuino/website-www.codeuino.org/issues).

## Something Else?

Want to talk about something but can't find a home for it here? Head to our [Slack Channel](http://slack.codeuino.org/) to discuss everything from feedback and ideas to questions and random musings.

## How to update your local master branch
* First of all add upstream remote. You can add upstream like
```bash
git remote add upstream https://github.com/codeuino/website-www.codeuino.org.git
```
* Now fetch the updated master branch
```bash
git fetch upstream
```
* Now merge fetch code to your local branch master
```bash
git merge upstream/master
```