2
0
mirror of https://github.com/Ionaru/easy-markdown-editor synced 2025-06-27 13:11:01 -06:00
easy-markdown-editor/CONTRIBUTING.md

45 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2019-02-11 15:19:08 +01:00
# Contributing
2020-10-16 14:35:34 +02:00
Thank you so much for your interest in contributing to EasyMDE!
2019-02-11 15:19:08 +01:00
2020-10-16 14:35:34 +02:00
## Asking questions, suggesting ideas or reporting bugs
2019-02-11 15:19:08 +01:00
2020-10-16 14:35:34 +02:00
You can [submit an issue](https://github.com/Ionaru/easy-markdown-editor/issues) on this GitHub repository.
2019-02-11 15:19:08 +01:00
## Coding
### 📦 Prerequisites
2019-02-11 15:19:08 +01:00
2020-10-16 14:35:34 +02:00
To contribute code to this project you'll need an up-to-date LTS or current version of Node.js and npm.
2019-02-11 15:19:08 +01:00
2020-10-16 14:35:34 +02:00
Please find information about the installation on [the official Node.js website](https://nodejs.org/en/download/).
2019-02-11 15:19:08 +01:00
2020-10-16 14:35:34 +02:00
### ⤴️ Workflow
2020-10-16 14:35:34 +02:00
Please make sure any code you submit is compliant and compatible with this repository's [license](./LICENSE).
2019-02-11 15:19:08 +01:00
2020-10-16 14:35:34 +02:00
#### 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!
2019-02-11 15:19:08 +01:00
2020-10-16 14:35:34 +02:00
#### 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.
2019-02-11 15:19:08 +01:00
Thank you! 💜