From e4b2635c106a56eb6c4962d16ca0f10d8821626c Mon Sep 17 00:00:00 2001 From: M-ZubairAhmed Date: Sun, 12 Nov 2017 01:24:13 +0530 Subject: [PATCH 01/10] little bit on nvm --- CONTRIBUTING.md | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 87a55e60c..5bd34b8c5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,40 @@ -# Contribution guidlines +# How to Contribute + +Coderplex web application comprises of two repositories : + +- [Coderplex](https://github.com/coderplex/coderplex) * : Frontend of the application + +- [Coderplex-Backend](https://github.com/coderplex/coderplex-backend) : Backend of the application + +Both of them are under very active development. This document provides non exhaustive guidelines for contributing to this repository. + +## Code of Conduct +Coderplex has adopted [Contributor Covenant](https://github.com/coderplex/coderplex/blob/docs-update/CODE_OF_CONDUCT.md) that we expect project participants to adhere to. + +## Open Development +All work related to web app takes place on Github itself. We use [Issues](https://github.com/coderplex/coderplex/issues) to track bugs, discuss ideas and work on improvements. [Projects](https://github.com/coderplex/coderplex/projects) are used to keep track of everything and is our project management app. We maintain [Wiki](https://github.com/coderplex/coderplex/wiki) for structuring our long term thoughts. Both maintainers and contributors sends a pull request which goes through the same review process. Whole process is as transparent as it can be and we strive to keep it that way. + +## Contribution Prerequisites +### NodeJS +Minimum Node version v8.0.0+ +```bash +To check node version +$ node -v + ``` +##### Using a Version Manager +If you prefer to keep LTS version or face problem updating your node then you might need a Node version manager tool. + +###### [nvm](https://github.com/creationix/nvm) for Linux & OSX +```bash +Install +$ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.6/install.sh | bash +``` +*Make sure you have cURL installed* + +###### [nvm-windows](https://github.com/coreybutler/nvm-windows) for Windows +It comes with a [installer](https://github.com/coreybutler/nvm-windows#installation--upgrades). + + We welcome pull requests from hackerspace members (our students) and seasoned JavaScript developers alike! Follow these steps to contribute: @@ -27,3 +63,8 @@ Working on your first Pull Request? You can learn how from this *free* series [H **Note:** > So our team's official policy (for now) is: We only use [Yarn](https://yarnpkg.com/en/docs/install) as our official Node package manager, and so we request you to use Yarn instead of npm and commit yarn.lock file. + + +## How to get in touch +- [Coderplex Discord Channel](https://discord.gg/dVnQ2Gf) +- Tweet maintainers From 6aabd70d17be8325ea19bbdec3d7ebef963e353d Mon Sep 17 00:00:00 2001 From: M-ZubairAhmed Date: Sun, 12 Nov 2017 13:25:32 +0530 Subject: [PATCH 02/10] added nvm instructions, new issues docs --- CONTRIBUTING.md | 84 ++++++++++++++++++++++++++++++++++--------------- 1 file changed, 59 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5bd34b8c5..11d42f369 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,43 +12,50 @@ Both of them are under very active development. This document provides non exhau Coderplex has adopted [Contributor Covenant](https://github.com/coderplex/coderplex/blob/docs-update/CODE_OF_CONDUCT.md) that we expect project participants to adhere to. ## Open Development -All work related to web app takes place on Github itself. We use [Issues](https://github.com/coderplex/coderplex/issues) to track bugs, discuss ideas and work on improvements. [Projects](https://github.com/coderplex/coderplex/projects) are used to keep track of everything and is our project management app. We maintain [Wiki](https://github.com/coderplex/coderplex/wiki) for structuring our long term thoughts. Both maintainers and contributors sends a pull request which goes through the same review process. Whole process is as transparent as it can be and we strive to keep it that way. +All work related to the application takes place on Github itself. We use [Issues](https://github.com/coderplex/coderplex/issues) to track bugs, discuss ideas and to engage open source contributors. [Projects](https://github.com/coderplex/coderplex/projects) are used to keep track of everything and is our project management tool. We maintain [Wiki](https://github.com/coderplex/coderplex/wiki) for structuring our long term thoughts. Both maintainers and contributors sends a pull request which goes through the same review process. Whole process is as transparent as it can be and we strive to keep it that way. -## Contribution Prerequisites -### NodeJS -Minimum Node version v8.0.0+ +## Development Workflow + +We welcome pull requests from beginners and seasoned javaScript developers alike! + +### Work on Issues +1. Find an issue that needs assistance by searching for the [open issues](https://github.com/coderplex/coderplex/labels/help-wanted). +2. If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort. +3. If somebody claims an issue but doesn’t follow up for more than a weeks, it’s fine to take over it but you should still leave a comment. + + +### Proposing a Change +1. Open a new issue if you would like report a bug or suggest improvements. +2. Please wait for maintainers to comment on the thread. This lets us reach an agreement on your proposal before you put significant effort into it. + +### Prerequisites +##### 1. [NodeJS](https://nodejs.org/) +Minimum version v8.0.0+ ```bash To check node version $ node -v ``` -##### Using a Version Manager -If you prefer to keep LTS version or face problem updating your node then you might need a Node version manager tool. - -###### [nvm](https://github.com/creationix/nvm) for Linux & OSX -```bash -Install -$ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.6/install.sh | bash -``` -*Make sure you have cURL installed* - -###### [nvm-windows](https://github.com/coreybutler/nvm-windows) for Windows -It comes with a [installer](https://github.com/coreybutler/nvm-windows#installation--upgrades). +Any lower version than mentioned above may results in this [error](https://github.com/coderplex/coderplex/issues/100). +> If you face problem updating your node then you might need a Node version manager tool. [Follow here]() +##### 2.[Yarn](https://yarnpkg.com) +Minimum version v1.2.0+ +
+Installing instructions are at [official docs](https://yarnpkg.com/en/docs/install#windows-tab) -We welcome pull requests from hackerspace members (our students) and seasoned JavaScript developers alike! Follow these steps to contribute: +Use yarn over npm +> Our team's official policy (for now) is: We only use [Yarn](https://yarnpkg.com/en/docs/install) as our official Node package manager, and so we request you to use Yarn instead of npm and commit `yarn.lock` file. -1. Find an issue that needs assistance by searching for the [Help Wanted](https://github.com/coderplex/coderplex/labels/help-wanted) tag. +##### 3. [GIT](https://git-scm.com/download/linux) +Familiarity with git is mandatory. -1. Let us know you are working on it by posting a comment on the issue. - -1. Follow the [Contribution Guidelines](#contribution-guidelines) to start working on the issue. Remember to feel free to ask for help in our [Discord](https://discordapp.com/invite/dVnQ2Gf) rooms. Working on your first Pull Request? You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) -## Running this project locally +### Running locally 1. Make sure you have [NodeJS](https://nodejs.org/) and [Yarn](https://yarnpkg.com/en/docs/install) installed. > Make sure you install node version 8 or above and check node version by running `node -v` @@ -61,10 +68,37 @@ Working on your first Pull Request? You can learn how from this *free* series [H 1. `npm run dev` to start local development server 1. App opens at `localhost:3000` -**Note:** -> So our team's official policy (for now) is: We only use [Yarn](https://yarnpkg.com/en/docs/install) as our official Node package manager, and so we request you to use Yarn instead of npm and commit yarn.lock file. - ## How to get in touch - [Coderplex Discord Channel](https://discord.gg/dVnQ2Gf) - Tweet maintainers + +## Appendix +#### 1. Node Version Manager + +##### [nvm](https://github.com/creationix/nvm) for Linux & OSX +```bash +Installation +$ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.6/install.sh | bash + +Install latest node lts +$ nvm install --lts + +Use installed version +$ nvm use --lts + +Run the app in the same terminal session +``` +*Make sure you have [curl](https://curl.haxx.se/) installed* + +##### [nvm-windows](https://github.com/coreybutler/nvm-windows) for Windows +It comes with an [installer](https://github.com/coreybutler/nvm-windows#installation--upgrades). + +```bash +Install particular version +$ nvm install 8.9.1 + +Use installed version +$ nvm use 8.9.1 +``` +Still facing problem this [article](https://medium.com/appseed-io/how-to-run-multiple-versions-of-node-js-with-nvm-for-windows-ffbe5c7a2b47) from [@skounis ](https://twitter.com/skounis) explain in details. From f81e9edd1d8dc7225d44d1be140d3dab3ce3b6f9 Mon Sep 17 00:00:00 2001 From: M-ZubairAhmed Date: Sun, 12 Nov 2017 16:10:06 +0530 Subject: [PATCH 03/10] completed contributing --- CONTRIBUTING.md | 114 +++++++++++++++++++++++++++++++++--------------- 1 file changed, 80 insertions(+), 34 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 11d42f369..88f622feb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ Both of them are under very active development. This document provides non exhau Coderplex has adopted [Contributor Covenant](https://github.com/coderplex/coderplex/blob/docs-update/CODE_OF_CONDUCT.md) that we expect project participants to adhere to. ## Open Development -All work related to the application takes place on Github itself. We use [Issues](https://github.com/coderplex/coderplex/issues) to track bugs, discuss ideas and to engage open source contributors. [Projects](https://github.com/coderplex/coderplex/projects) are used to keep track of everything and is our project management tool. We maintain [Wiki](https://github.com/coderplex/coderplex/wiki) for structuring our long term thoughts. Both maintainers and contributors sends a pull request which goes through the same review process. Whole process is as transparent as it can be and we strive to keep it that way. +All work related to the application takes place on Github itself. We use [Issues](https://github.com/coderplex/coderplex/issues) to track bugs, discuss ideas and to engage open source contributors. [Projects](https://github.com/coderplex/coderplex/projects) are used to keep track of everything and is our project management tool. We maintain [Wiki](https://github.com/coderplex/coderplex/wiki) for structuring our long term thoughts. Both core team members and contributors sends a pull request which goes through the same review process. Whole process is as transparent as it can be and we strive to keep it that way. ## Development Workflow @@ -26,57 +26,100 @@ We welcome pull requests from beginners and seasoned javaScript developers alike ### Proposing a Change 1. Open a new issue if you would like report a bug or suggest improvements. -2. Please wait for maintainers to comment on the thread. This lets us reach an agreement on your proposal before you put significant effort into it. +2. Please wait for core team members to comment on the thread. This lets us reach an agreement on your proposal before you put significant effort into it. ### Prerequisites -##### 1. [NodeJS](https://nodejs.org/) +1. [NodeJS](https://nodejs.org/) +
Minimum version v8.0.0+ -```bash -To check node version -$ node -v - ``` -Any lower version than mentioned above may results in this [error](https://github.com/coderplex/coderplex/issues/100). + ```bash + To check node version + $ node -v + ``` + Any lower version than mentioned above may results in this [error](https://github.com/coderplex/coderplex/issues/100). -> If you face problem updating your node then you might need a Node version manager tool. [Follow here]() + > If you face problem updating your node then you might need a Node version manager tool. [Follow here]() -##### 2.[Yarn](https://yarnpkg.com) -Minimum version v1.2.0+ -
-Installing instructions are at [official docs](https://yarnpkg.com/en/docs/install#windows-tab) +2. [Yarn](https://yarnpkg.com) +
+ Minimum version v1.2.0+ +
+ Installing instructions are at [official docs](https://yarnpkg.com/en/docs/install#windows-tab). + Use yarn over npm + > Our team's official policy (for now) is: We only use [Yarn](https://yarnpkg.com/en/docs/install) as our official Node package manager, and so we request you to use Yarn instead of npm and commit `yarn.lock` file. -Use yarn over npm -> Our team's official policy (for now) is: We only use [Yarn](https://yarnpkg.com/en/docs/install) as our official Node package manager, and so we request you to use Yarn instead of npm and commit `yarn.lock` file. - -##### 3. [GIT](https://git-scm.com/download/linux) -Familiarity with git is mandatory. +3. [Git](https://git-scm.com/download/linux) +
+ Familiarity with git is mandatory. Remember to feel free to ask for help in our [Discord](https://discordapp.com/invite/dVnQ2Gf) rooms. -Working on your first Pull Request? You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) -### Running locally +### Running -1. Make sure you have [NodeJS](https://nodejs.org/) and [Yarn](https://yarnpkg.com/en/docs/install) installed. - > Make sure you install node version 8 or above and check node version by running `node -v` -1. Then clone this repo +1. Clone repository + ```bash + $ git clone https://github.com/coderplex/coderplex.git + ``` +2. Move to the repository root folder + ```bash + $ cd coderplex + ``` +3. Install dependencies ```bash - git clone https://github.com/coderplex/coderplex.git + $ yarn ``` -1. `cd coderplex` -1. `npm install` -1. `npm run dev` to start local development server -1. App opens at `localhost:3000` +4. Start the development server + ```bash + $ yarn dev + ``` + App now opens at `localhost:3000` in your default browser. + > You may get this [error]() if any other app is already running the above port. +### Sending a Pull Request -## How to get in touch -- [Coderplex Discord Channel](https://discord.gg/dVnQ2Gf) -- Tweet maintainers +*Working on your first Pull Request? You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)* + +#### Before submitting: +1. Fork the [repository](https://github.com/coderplex/coderplex). +2. From your fork, create a [branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/) and name it. eg. `typo-in-readme` +3. If you’ve fixed a bug or added code that should be tested, add tests! +4. Ensure that all test pass + ```bash + $ yarn test + ``` +5. Run code formatters + ```bash + $ yarn lint + ``` +6. Add and commit your code. Please give meaning full commit messages. +7. Pull latest code from [upstream repository's ](https://help.github.com/articles/merging-an-upstream-repository-into-your-fork/)`master`, if in case anything new were merged while you were working on your fork. +8. Push the code to your fork. +9. Raise the pull request from your created branch to `master` branch of coderplex. +10. Take some time to give a brief description of the work you have done. + +#### After submitting +1. Wait for all checks to pass in below section. +2. Your changes are deployed with a unique link `https://deploy-preview-xx--coderplex.netlify.com`.
+*`- xx` is your pull request number.* +3. The core team will review your pull request and either merge it, request changes to it, or close it with an explanation. + +##### Received a review request +- Work on the requested changes +- Push the changes as you did earlier, the pull request will automatically catch those and update itself. + +### How to get in touch +- Coderplex [Discord Channel](https://discord.gg/dVnQ2Gf) +- Tweet core team members : + - Vinay Puppal [@VinayPuppal](https://twitter.com/vinaypuppal) + - Md-ZubairAhmed [@Md_ZubairAhmed](https://twitter.com/Md_ZubairAhmed) + - P Bhanu Teja [@pbteja1998](https://twitter.com/pbteja1998) ## Appendix -#### 1. Node Version Manager +##### 1. Node Version Manager -##### [nvm](https://github.com/creationix/nvm) for Linux & OSX +###### [nvm](https://github.com/creationix/nvm) for Linux & OSX ```bash Installation $ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.6/install.sh | bash @@ -91,7 +134,7 @@ Run the app in the same terminal session ``` *Make sure you have [curl](https://curl.haxx.se/) installed* -##### [nvm-windows](https://github.com/coreybutler/nvm-windows) for Windows +###### [nvm-windows](https://github.com/coreybutler/nvm-windows) for Windows It comes with an [installer](https://github.com/coreybutler/nvm-windows#installation--upgrades). ```bash @@ -102,3 +145,6 @@ Use installed version $ nvm use 8.9.1 ``` Still facing problem this [article](https://medium.com/appseed-io/how-to-run-multiple-versions-of-node-js-with-nvm-for-windows-ffbe5c7a2b47) from [@skounis ](https://twitter.com/skounis) explain in details. + +##### 2. Local host occupied +If you get this error while running `yarn dev` then probably another app is occupying `localhost:3000`. You may want to close that and run the command again. From ef97fe3d1d29169e6dbef2c7faa26519eecab524 Mon Sep 17 00:00:00 2001 From: Zubair Ahmed Date: Sun, 12 Nov 2017 16:16:35 +0530 Subject: [PATCH 04/10] error added and indent spaces --- CONTRIBUTING.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 88f622feb..2be62d621 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,14 +30,13 @@ We welcome pull requests from beginners and seasoned javaScript developers alike ### Prerequisites 1. [NodeJS](https://nodejs.org/) -
-Minimum version v8.0.0+ +
+ Minimum version v8.0.0+ ```bash To check node version $ node -v ``` Any lower version than mentioned above may results in this [error](https://github.com/coderplex/coderplex/issues/100). - > If you face problem updating your node then you might need a Node version manager tool. [Follow here]() 2. [Yarn](https://yarnpkg.com) @@ -147,4 +146,16 @@ $ nvm use 8.9.1 Still facing problem this [article](https://medium.com/appseed-io/how-to-run-multiple-versions-of-node-js-with-nvm-for-windows-ffbe5c7a2b47) from [@skounis ](https://twitter.com/skounis) explain in details. ##### 2. Local host occupied +```bash +Error: listen EADDRINUSE :::3000 + at Object._errnoException (util.js:1024:11) + at _exceptionWithHostPort (util.js:1046:20) + at Server.setupListenHandle [as _listen2] (net.js:1351:14) + at listenInCluster (net.js:1392:12) + at Server.listen (net.js:1476:7) + at app.prepare.then (/home/m-zubairahmed/github/official/coderplex-frontend/server.js:26:6) + at + at process._tickCallback (internal/process/next_tick.js:188:7) +error Command failed with exit code 1. +``` If you get this error while running `yarn dev` then probably another app is occupying `localhost:3000`. You may want to close that and run the command again. From 470eba2bc9bcdbdb92cc2d38ab064364d0965d24 Mon Sep 17 00:00:00 2001 From: M-ZubairAhmed Date: Sun, 12 Nov 2017 16:22:59 +0530 Subject: [PATCH 05/10] index fix --- CONTRIBUTING.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2be62d621..5bed56f18 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,12 +48,8 @@ We welcome pull requests from beginners and seasoned javaScript developers alike > Our team's official policy (for now) is: We only use [Yarn](https://yarnpkg.com/en/docs/install) as our official Node package manager, and so we request you to use Yarn instead of npm and commit `yarn.lock` file. 3. [Git](https://git-scm.com/download/linux) -
- Familiarity with git is mandatory. - - -Remember to feel free to ask for help in our [Discord](https://discordapp.com/invite/dVnQ2Gf) rooms. - +
+ Familiarity with git is mandatory. ### Running From 1114105f79536df17bf19e0f1a4775bae17f8811 Mon Sep 17 00:00:00 2001 From: z Date: Thu, 16 Nov 2017 15:48:24 +0530 Subject: [PATCH 06/10] branching system added --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5bed56f18..5eea7bd53 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,6 +23,10 @@ We welcome pull requests from beginners and seasoned javaScript developers alike 2. If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort. 3. If somebody claims an issue but doesn’t follow up for more than a weeks, it’s fine to take over it but you should still leave a comment. +### Branching Model +The `master` branch of coderplex is relatively stable branch which we update for every release. We also have auto deployment in place for that particular branch i.e any changes in that branch gets reflected in [https://coderplex.org](https://coderplex.org). Before every release we throughly test develop branch and merge into master. +![Imgur](https://i.imgur.com/KPO2dLul.png) +Hence it is recommended for both maintainers and contributors to raise a pull request to `develop` branch. ### Proposing a Change 1. Open a new issue if you would like report a bug or suggest improvements. @@ -91,7 +95,7 @@ We welcome pull requests from beginners and seasoned javaScript developers alike 6. Add and commit your code. Please give meaning full commit messages. 7. Pull latest code from [upstream repository's ](https://help.github.com/articles/merging-an-upstream-repository-into-your-fork/)`master`, if in case anything new were merged while you were working on your fork. 8. Push the code to your fork. -9. Raise the pull request from your created branch to `master` branch of coderplex. +9. Raise the pull request from your created branch to `develop` branch of coderplex. [why develop instead of master branch?]() 10. Take some time to give a brief description of the work you have done. #### After submitting @@ -155,3 +159,6 @@ Error: listen EADDRINUSE :::3000 error Command failed with exit code 1. ``` If you get this error while running `yarn dev` then probably another app is occupying `localhost:3000`. You may want to close that and run the command again. + +##### 3. Why we recommend sending new pull requests to `develop` instead of `master` branch ? +The master branch of coderplex is relatively stable branch which we update for every release. We also have auto deployment in place for master branch i.e any changes in that branch gets reflected in `https://coderplex.org`. Every release we throughly test develop branch and merge into master. Hence it is recommended for both maintainers and contributors to raise a pull request to `develop` branch. From b5b25d1d491bb8a59c3c1ca3afb8417b2484f0ac Mon Sep 17 00:00:00 2001 From: z Date: Thu, 16 Nov 2017 16:16:11 +0530 Subject: [PATCH 07/10] sectios rearranged --- CONTRIBUTING.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5eea7bd53..57614e88e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,13 @@ Coderplex has adopted [Contributor Covenant](https://github.com/coderplex/coderp ## Open Development All work related to the application takes place on Github itself. We use [Issues](https://github.com/coderplex/coderplex/issues) to track bugs, discuss ideas and to engage open source contributors. [Projects](https://github.com/coderplex/coderplex/projects) are used to keep track of everything and is our project management tool. We maintain [Wiki](https://github.com/coderplex/coderplex/wiki) for structuring our long term thoughts. Both core team members and contributors sends a pull request which goes through the same review process. Whole process is as transparent as it can be and we strive to keep it that way. +## Branching Model +The `master` branch of coderplex is relatively stable branch which we update for every release. We also have auto deployment in place for that particular branch i.e any changes in that branch gets reflected in [https://coderplex.org](https://coderplex.org). +It is highly recommended for both maintainers and contributors to raise a pull request to `develop` branch. Before every release we throughly test develop branch and merge into master. +![Imgur](https://i.imgur.com/KPO2dLul.png) +
+*A pull request to any other branch may most likely be closed by our bots.* + ## Development Workflow We welcome pull requests from beginners and seasoned javaScript developers alike! @@ -23,10 +30,6 @@ We welcome pull requests from beginners and seasoned javaScript developers alike 2. If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort. 3. If somebody claims an issue but doesn’t follow up for more than a weeks, it’s fine to take over it but you should still leave a comment. -### Branching Model -The `master` branch of coderplex is relatively stable branch which we update for every release. We also have auto deployment in place for that particular branch i.e any changes in that branch gets reflected in [https://coderplex.org](https://coderplex.org). Before every release we throughly test develop branch and merge into master. -![Imgur](https://i.imgur.com/KPO2dLul.png) -Hence it is recommended for both maintainers and contributors to raise a pull request to `develop` branch. ### Proposing a Change 1. Open a new issue if you would like report a bug or suggest improvements. @@ -55,7 +58,11 @@ Hence it is recommended for both maintainers and contributors to raise a pull re
Familiarity with git is mandatory. -### Running +### Sending a Pull Request + +*Working on your first Pull Request? You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)* + +#### Running Locally 1. Clone repository ```bash @@ -76,10 +83,6 @@ Hence it is recommended for both maintainers and contributors to raise a pull re App now opens at `localhost:3000` in your default browser. > You may get this [error]() if any other app is already running the above port. -### Sending a Pull Request - -*Working on your first Pull Request? You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)* - #### Before submitting: 1. Fork the [repository](https://github.com/coderplex/coderplex). 2. From your fork, create a [branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/) and name it. eg. `typo-in-readme` From 486e968a90f92dfb06867ce9b0ee0319aa34fdfd Mon Sep 17 00:00:00 2001 From: z Date: Thu, 16 Nov 2017 16:17:53 +0530 Subject: [PATCH 08/10] start removed --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 57614e88e..d21a36357 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Coderplex web application comprises of two repositories : -- [Coderplex](https://github.com/coderplex/coderplex) * : Frontend of the application +- [Coderplex](https://github.com/coderplex/coderplex) : Frontend of the application - [Coderplex-Backend](https://github.com/coderplex/coderplex-backend) : Backend of the application From aa5f874c7b7139359a76aa62174aae31715853cf Mon Sep 17 00:00:00 2001 From: z Date: Thu, 16 Nov 2017 16:20:58 +0530 Subject: [PATCH 09/10] removed extra section of branching model --- CONTRIBUTING.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d21a36357..60233ab86 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -162,6 +162,3 @@ Error: listen EADDRINUSE :::3000 error Command failed with exit code 1. ``` If you get this error while running `yarn dev` then probably another app is occupying `localhost:3000`. You may want to close that and run the command again. - -##### 3. Why we recommend sending new pull requests to `develop` instead of `master` branch ? -The master branch of coderplex is relatively stable branch which we update for every release. We also have auto deployment in place for master branch i.e any changes in that branch gets reflected in `https://coderplex.org`. Every release we throughly test develop branch and merge into master. Hence it is recommended for both maintainers and contributors to raise a pull request to `develop` branch. From 01d3e02dd09d9485d45e8e3f881cc4e60348a8aa Mon Sep 17 00:00:00 2001 From: z Date: Thu, 16 Nov 2017 16:23:20 +0530 Subject: [PATCH 10/10] fix of https://github.com/coderplex/coderplex/pull/105#pullrequestreview-77076077 --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 60233ab86..ca857b5a6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,7 +96,7 @@ We welcome pull requests from beginners and seasoned javaScript developers alike $ yarn lint ``` 6. Add and commit your code. Please give meaning full commit messages. -7. Pull latest code from [upstream repository's ](https://help.github.com/articles/merging-an-upstream-repository-into-your-fork/)`master`, if in case anything new were merged while you were working on your fork. +7. Pull latest code from [upstream repository's ](https://help.github.com/articles/merging-an-upstream-repository-into-your-fork/)`develop`, if in case anything new were merged while you were working on your fork. 8. Push the code to your fork. 9. Raise the pull request from your created branch to `develop` branch of coderplex. [why develop instead of master branch?]() 10. Take some time to give a brief description of the work you have done.