Skip to content

Commit

Permalink
docs(contributing): Add some more info to contributing guide (#54)
Browse files Browse the repository at this point in the history
* docs(contributing): Add some more info to contributing guide

* build: fix settings generation to handle null values

We cant set undefined in the config so it's fine to remove the undefined check

* docs(contributing): add missing word
  • Loading branch information
ewanharris authored and longton95 committed Mar 7, 2019
1 parent a0832ac commit edfede6
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# Contributing

Interested in contributing? You can follow the information below to ensure your contribution goes smoothly and is a great experience.

## File an issue

For any contribution we first ask that you [file an issue](https://github.com/appcelerator/vscode-appcelerator-titanium/issues/new/choose), this helps us keep track of any necessary changes, as well as discuss and agree on a plan of action to ensure landing your changes goes as smoothly as possible.

## Getting set up for development

1. Just to be safe, remove or move your existing installation at `~/.vscode/extensions/???`
Expand All @@ -12,7 +20,7 @@ You're now up and running with the extension running in another workspace. When

When sending in a PR please make sure you do the following:

- Commit using `npm run commit`
- Commit using `npm run commit`, making sure to reference your issue ID when the prompting asks.
- This ensure that the commit follows the [Conventional Commits](https://www.conventionalcommits.org/) standard used by the project. This is validated on a `git commit` using git hooks via husky.
- `npm run lint` passes
- This is also validated on a `git commit` using git hooks via husky.
Expand All @@ -26,6 +34,7 @@ To release of the extension the following needs to be followed:

1. Ensure that your local `master` branch is completely up to date with the main repo.
2. Run `npm run release`, which performs the following
- Runs `scripts/generate-settings-table.js` to ensure the configuration settings documentation is up to date.
- Runs [standard-version](https://github.com/conventional-changelog/standard-version) to bump versions based on commit messages, updates the changelog, commits the files and tags a new release.
- Runs `npx vsce package` to generate a new `.vsix` file ready for upload to the marketplace.
3. Push to the main repo.
Expand Down
2 changes: 1 addition & 1 deletion scripts/generate-settings-table.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ const { contributes: { configuration } } = require('../package.json');
let tableString = '| Setting name | Description | Default Value |';
tableString = `${tableString}\n| ------------- | ------------- | ----- |`
for (const [ name, settingInfo ] of Object.entries(configuration.properties)) {
const defaultValue = settingInfo.default === undefined || settingInfo.default.length === 0 ? 'No Default' : settingInfo.default;
const defaultValue = settingInfo.default === null || settingInfo.default.length === 0 ? 'No Default' : settingInfo.default;
tableString = `${tableString}\n| \`${name}\` | ${settingInfo.description} | \`${defaultValue}\` |`
}

Expand Down

0 comments on commit edfede6

Please sign in to comment.