|
1 |
| -# Contribution guidlines |
| 1 | +# How to Contribute |
| 2 | + |
| 3 | +Coderplex web application comprises of two repositories : |
| 4 | + |
| 5 | +- [Coderplex](https://github.com/coderplex/coderplex) * : Frontend of the application |
| 6 | + |
| 7 | +- [Coderplex-Backend](https://github.com/coderplex/coderplex-backend) : Backend of the application |
| 8 | + |
| 9 | +Both of them are under very active development. This document provides non exhaustive guidelines for contributing to this repository. |
| 10 | + |
| 11 | +## Code of Conduct |
| 12 | +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. |
| 13 | + |
| 14 | +## Open Development |
| 15 | +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. |
| 16 | + |
| 17 | +## Contribution Prerequisites |
| 18 | +### NodeJS |
| 19 | +Minimum Node version v8.0.0+ |
| 20 | +```bash |
| 21 | +To check node version |
| 22 | +$ node -v |
| 23 | + ``` |
| 24 | +##### Using a Version Manager |
| 25 | +If you prefer to keep LTS version or face problem updating your node then you might need a Node version manager tool. |
| 26 | + |
| 27 | +###### [nvm](https://github.com/creationix/nvm) for Linux & OSX |
| 28 | +```bash |
| 29 | +Install |
| 30 | +$ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.6/install.sh | bash |
| 31 | +``` |
| 32 | +*Make sure you have cURL installed* |
| 33 | + |
| 34 | +###### [nvm-windows](https://github.com/coreybutler/nvm-windows) for Windows |
| 35 | +It comes with a [installer](https://github.com/coreybutler/nvm-windows#installation--upgrades). |
| 36 | + |
| 37 | + |
2 | 38 |
|
3 | 39 | We welcome pull requests from hackerspace members (our students) and seasoned JavaScript developers alike! Follow these steps to contribute:
|
4 | 40 |
|
@@ -27,3 +63,8 @@ Working on your first Pull Request? You can learn how from this *free* series [H
|
27 | 63 |
|
28 | 64 | **Note:**
|
29 | 65 | > 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.
|
| 66 | +
|
| 67 | +
|
| 68 | +## How to get in touch |
| 69 | +- [Coderplex Discord Channel](https://discord.gg/dVnQ2Gf) |
| 70 | +- Tweet maintainers |
0 commit comments