From 6d173d0024dc86974ac1d0aa4baae108cc096867 Mon Sep 17 00:00:00 2001 From: Jeroen Akkerman Date: Fri, 16 Oct 2020 14:35:34 +0200 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 69 ++++++++++++++++++------------------------------- 1 file changed, 25 insertions(+), 44 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7490073..d8f23db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,63 +1,44 @@ # Contributing -Hey, welcome to the party! 🎉 - -Thank you so much for contributing to EasyMDE. 😘 +Thank you so much for your interest in contributing to EasyMDE! -## Asking questions, suggesting wonderful ideas or reporting bugs +## Asking questions, suggesting ideas or reporting bugs -You can [submit an issue️](https://github.com/Ionaru/easy-markdown-editor/issues/new) on this GitHub repository. +You can [submit an issue️](https://github.com/Ionaru/easy-markdown-editor/issues) on this GitHub repository. ## Coding ### 📦 Prerequisites -You need Node.js and npm. +To contribute code to this project you'll need an up-to-date LTS or current version of Node.js and npm. -To install them on Debian-based systems: - -```bash -curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash - -sudo apt-get install -y nodejs -echo -e "nodejs version:\t$(nodejs -v) \nnpm version:\t$(npm -v)" -# check that you have node.js and npm. -``` - -For other systems, please [read the official page](https://nodejs.org/en/download/). +Please find information about the installation on [the official Node.js website](https://nodejs.org/en/download/). -### 🏗️ Installation +### ⤴️ Workflow -Here we go! 🤠 First, clone this repository: +Please make sure any code you submit is compliant and compatible with this repository's [license](./LICENSE). -```bash -git clone https://github.com/Ionaru/easy-markdown-editor.git -cd easy-markdown-editor -``` +#### Your first pull request +1. [Create a fork of this project](https://github.com/Ionaru/easy-markdown-editor/fork). +1. Clone your fork: `git clone https://github.com/YOUR_USERNAME/easy-markdown-editor.git`. +1. Add the original repository as remote to keep it up-to-date: `git remote add upstream https://github.com/Ionaru/easy-markdown-editor.git`. +1. Fetch the latest changes from upstream: `git fetch upstream`. +1. Run `npm ci` to install the required dependencies. +1. Create a new branch to work on: `git checkout -b MyNewFeatureName`. +1. Write your awesome improvement and commit your work. +1. Make sure your changes comply with the established code and tests succeed: `npm run test`. +1. Push your changes to GitHub: `git push origin`. +1. On GitHub, go to your forked branch, and click **New pull request**. +1. Choose the correct branches, add a description and submit your pull request! -Then install the required dependencies: - -```bash -npm install -``` - -Yay! You are ready! 🍾 - - -### ⤴️ Creating a pull request - -1. First, [create a fork of this project](https://github.com/Ionaru/easy-markdown-editor/fork), and copy the https URL (*clone or download* button) of your project (something like https://github.com/YOUR_USERNAME/easy-markdown-editor.git ); -2. a) If you already cloned and worked on the project: `git remote add source https://github.com/Ionaru/easy-markdown-editor.git`; -b) Otherwise, clone your fork: `git clone https://github.com/YOUR_USERNAME/easy-markdown-editor.git`; -3. Create a new dedicated branch `git checkout -b myMergeRequest`; -4. Write some nice code and commit your work. (Don't forget to add your changes to the changelog!); -5. Check files against the ESLint syntax and build minified versions: `gulp`; -6. Test your changes; -7. Push it to a dedicated branch `git push origin myMergeRequest`; -8. Go to the [main project page](https://github.com/Ionaru/easy-markdown-editor) and click on the button *Compare and pull request*, then fill the description. - -If you want to make other pull requests, go back to the master branch (`git checkout master`), update it (`git pull --rebase source master`), then follow the instructions above from step 3. +#### Continuing development +To create more pull requests, please follow the steps below: +1. Go back to the master branch: `git checkout master`. +1. Fetch the upstream changes: `git fetch upstream`. +1. Update the master branch with upstream changes: `git merge upstream/master`. +1. Repeat ["Your first pull request"](#your-first-pull-request) from step 5. Thank you! 💜