diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..24c2f3c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,46 @@ +# Contributing to telescope-bookmarks.nvim + +Thank you for investing your time in contributing to this project! 🎉 + +## Getting started + +You can look at the currently open +[issues](https://github.com/dhruvmanila/telescope-bookmarks.nvim/issues) to see +if there's a feature which you would like to work on or a reported bug to fix. + +### Development + +Development of this project happens on GitHub using issues and pull requests. +Please open an issue first for feature requests and bug reports. A pull request +can be opened directly if the changes are small enough. + +### Formatting + +The project uses [stylua](https://github.com/JohnnyMorganz/StyLua) for code +formatting. It can be run using `make fmt`. + +### Testing + +The project uses [vusted](https://github.com/notomo/vusted) for testing. Please +refer to the project README for installation instructions. The tests can be run +using `make` with the following command: + +``` +make test +``` + +This will install the dependencies such as `telescope.nvim`, etc. in a `.deps` +directory and invoke the `vusted` command. To use the latest version of the +dependencies for testing, remove them using `make clean` and then invoke the +test target again. + +#### Code coverage + +The project uses [luacov](https://github.com/lunarmodules/luacov) for coverage +reports. Please refer to the project README for installation instructions. The +coverage report is generated automatically when running `vusted`. + +## Release process + +The project follows [Semantic Versioning](https://semver.org/). The release +process is done manually using GitHub Releases. diff --git a/README.md b/README.md index 22386cc..805b029 100644 --- a/README.md +++ b/README.md @@ -196,6 +196,11 @@ the respective plugin function used to open the URL: * [open-browser.vim](https://github.com/tyru/open-browser.vim) - `openbrowser#open` * [vim-external](https://github.com/itchyny/vim-external) - `external#browser` +## Contributing + +Contributions are always welcome and highly appreciated. Refer to the +[Contributing Guidelines](./CONTRIBUTING.md). + ## References * [Browsing Chrome bookmarks with fzf](https://junegunn.kr/2015/04/browsing-chrome-bookmarks-with-fzf/)