Development Workflow

Branch Conventions

Only time-critical bugfixes or possibly trivial doc changes go directly into master.

Versions

vim-devicons uses, at least to the best of my ability, semantic versioning.

Automated Testing

todo - it is coming

Issues

New release workflow

• pull latest master branch
• create new versioned branch "MAJOR.MINOR.PATCH", e.g. 0.5.3
• merge any PRs that go in the milestone
• commit any general issue fixes/updates that go in the milestone
• update the readme if applicable
• update the changelog
• update internal version references in all .vim files that have them
• regenerate the vim doc automatically with html2vimdoc
• e.g.

cd ~
html2vimdoc/bin/python ./vim-tools/html2vimdoc.py ~/projects/vim-devicons/readme.md > ~/projects/vim-devicons/doc/webdevicons.txt
cd ~/projects/vim-devicons/

• push the new branch
• merge to master
• create tag
• push latest master