gitbot/twemoji
1
0
Fork 0
mirror of https://github.com/twitter/twemoji.git synced 2024-06-15 03:35:16 +00:00
Code Issues Projects Releases Wiki Activity

Update contributing steps

Browse Source
This commit is contained in:
Alan Velasco 2019-06-28 12:46:01 -07:00
parent 976a2364bb
commit 19b55ac6ec
1 changed files with 31 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
CONTRIBUTING.md
View File

@ -35,29 +35,26 @@ have good reasons for rejecting.
## Making Changes ## Making Changes
### Build
If you'd like to test and/or contribute please follow these instructions. If you'd like to test and/or contribute please follow these instructions.
[Fork this repo on GitHub](https://github.com/twitter/twemoji.git/fork)
### Setup
```bash ```bash
# clone this repo # clone your fork
git clone -b gh-pages https://github.com/twitter/twemoji.git git clone -b master https://github.com/$YOUR_USERNAME/twemoji.git/
cd twemoji cd twemoji
# install dependencies # install dependencies
yarn install yarn install
# generate 2/twemoji*.js files # Build and test your installation
./2/scripts/generate yarn build
yarn test
``` ```
If you'd like to test and/or propose some changes to the V2 library please change the `./2/scripts/generate` file at its end so that everything will be generated properly once launched. ### Making changes
## Pull requests
Good pull requests - patches, improvements, new features - are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.
Make sure to adhere to the coding conventions used throughout the codebase Make sure to adhere to the coding conventions used throughout the codebase
(indentation, accurate comments, etc.) and any other requirements (such as test (indentation, accurate comments, etc.) and any other requirements (such as test
@ -68,16 +65,32 @@ project:
1. Create a new topic branch to contain your feature, change, or fix: 1. Create a new topic branch to contain your feature, change, or fix:
2. Commit your changes in logical chunks. Provide clear and explanatory commit > If you'd like to test and/or propose some changes to the latest library version please change the `./scripts/generate` file at its end so that everything will be generated properly once launched.
1. Commit your changes in logical chunks. Provide clear and explanatory commit
messages. Use git's [interactive rebase](https://help.github.com/en/articles/about-git-rebase) messages. Use git's [interactive rebase](https://help.github.com/en/articles/about-git-rebase)
feature to tidy up your commits before making them public. feature to tidy up your commits before making them public.
3. Locally merge (or rebase) the upstream development branch into your topic branch: 2. Run `yarn prepublish`. This will do several things:
4. Push your topic branch up to your fork: 1. Ask for the version number (See: [SemVer](https://semver.org/))
2. Build the project and put the built assets in `dist/`
3. Run the tests
4. Move the contents of the `dist/` directory to the `gh-pages` branch
5. Place the contents of the `dist/` directory in its correspoding versioned folder.
6. Commit the changes and push them to the `gh-pages` branch of your fork.
5. [Open a Pull Request](http://help.github.com/send-pull-requests/) with a ## Pull requests
clear title and description.
Good pull requests - patches, improvements, new features - are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.
1. Push your topic branch up to your fork: `git push origin my-feature-branch`
2. [Open a Pull Request](http://help.github.com/send-pull-requests/) with a
clear title and description. One for your changes in `master` and another one for
your changes in `gh-pages`.
## License ## License