diff options
| author | Fausto Núñez Alberro <fausto.nunez@mailbox.org> | 2021-09-18 16:55:16 +0200 |
|---|---|---|
| committer | Fausto Núñez Alberro <fausto.nunez@mailbox.org> | 2021-09-18 16:55:16 +0200 |
| commit | 96cb6215c8eda1d20bc04454b3ee36aa504e639c (patch) | |
| tree | fd704977f6a23c3c2c40f4b959bc63a8976e90f8 | |
| parent | 52e4ce93a6234d112bc88e1ad25458904ffafe61 (diff) | |
Add CONTRIBUTING.md
| -rw-r--r-- | .github/pull_request_template.md | 4 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 38 | ||||
| -rw-r--r-- | README.md | 18 |
3 files changed, 44 insertions, 16 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0263490..d1e53d9 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,6 +6,8 @@ Fixes #ISSUE_NUMBER # Checklist -- [ ] I have built the project after my changes following [the build instructions](https://github.com/fnune/base16-vim#building) using `make` +- [ ] I have built the project after my changes following [the build + instructions](https://github.com/fnune/base16-vim/blob/master/CONTRIBUTING.md#building) + using `make` - [ ] I have confirmed that my changes produce no regressions after building - [ ] I have pushed the built files to this pull request diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b5fb1a3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing + +## Building + +Dependencies: + +- Python, at least version 3.5 +- The `pybase16` command from + [base16-builder-python](https://github.com/InspectorMustache/base16-builder-python) +- The `make` command + +For example on a Debian-based distribution: + +``` +# Install dependencies (you probably already have pip/pip3 and make) +apt install build-essential # for make +pip3 install pybase16-builder + +# Build the packages +make +``` + +## Submitting a PR + +After you've installed the build dependencies, and before you submit your PR: + +- Run `make` after you've made your changes. This will build all the themes + based on the changes you've made. +- Make sure to commit the changes from `make` and include them in your PR. +- Please abide by what's requested in the [PR + template](/.github/pull_request_template.md). + +## Submitting an issue + +Please follow the instructions in the issue templates: + +- [Issue template for bug reports](/.github/ISSUE_TEMPLATE/bug_report.md) +- [Issue template for feature requests](/.github/ISSUE_TEMPLATE/feature_request.md) @@ -95,18 +95,6 @@ augroup on_change_colorschema augroup END ``` -## Building -Dependencies: - -- Python, at least version 3.5 -- The `pybase16` command from [base16-builder-python](https://github.com/InspectorMustache/base16-builder-python) -- The `make` command - -``` -# Install dependencies (you probably already have pip/pip3 and make) -apt install build-essential # for make -pip3 install pybase16-builder - -# Build the packages -make -``` +## Contributing +See [`CONTRIBUTING.md`](/CONTRIBUTING.md), which contains building and +contributing instructions. |