-
Notifications
You must be signed in to change notification settings - Fork 3
Contributing
We welcome contributions to ce-dev! Please feel free to fork the repository, open issues and pull requests.
Thank you!
If you'd like to contribute code to ce-dev, here are the steps that will enable you to check out the code and work on it.
Visit https://github.com/codeenigma/ce-dev/fork to fork the repository to your GitHub account.
Change to the directory where you do your development work, run the following on the command line, replacing your-github-username appropriately:
git clone git@github.com:your-github-username/ce-dev.git
cd ce-dev && git remote add upstream git@github.com:codeenigma/ce-dev.git
At this point, the output of git remote -v should look something like this:
origin git@github.com:your-github-username/ce-dev.git (fetch)
origin git@github.com:your-github-username/ce-dev.git (push)
upstream git@github.com:codeenigma/ce-dev.git (fetch)
upstream git@github.com:codeenigma/ce-dev.git (push)
Create a branch off the default branch. At the time of writing, this is 2.x:
git fetch --all
git checkout 2.x
git pull upstream 2.x
git checkout -b your-branch
ce-dev is written in TypeScript, which is compiled to JavaScript... if you haven't already, install the required dependencies by running:
npm install
You will most likely be making changes to the TypeScript files located in the src directory. When you want to test your changes, run the following on the command line:
npm run build
You will also need to make the bin/run.js file executable with:
chmod u+x bin/run.js
Then you should be able to run:
/path/where/you/develop/ce-dev/bin/run.js
This will list all the available ce-dev commands.
Commit your changes and push your branch to your repository with:
git push origin your-branch
Lastly, browse to https://github.com/codeenigma/ce-dev/compare to open a pull request.