Skip to content

Latest commit

 

History

History
89 lines (64 loc) · 3.17 KB

CONTRIBUTING.MD

File metadata and controls

89 lines (64 loc) · 3.17 KB
Raw

Contributing

Bug fixes

Issues can be found on our GitHub issues page. Found a bug? Let us know! Report the bug by creating a new issue. Make sure to check the issues page before creating a new bug issue to prevent duplicate issues. Once you start fixing a bug, post your intent on the issue to prevent others diving in at the same time.

New features

Upcoming new features can be found on our GitHub issues page. Do you want to contribute by adding new features, open a Feature Request.

Documentation

If a PR introduces or changes API, mention one of the Yummygum team members to make sure it'll be processed into the website docs.

Development

If you wish to run the package locally, go through the following steps:

  1. Fork the svelte-flagpack repo and clone your fork to your system:
$: git clone https://github.com/{your-username}/svelte-flagpack.git
  1. Install the package
$: npm install
  1. Run npm link to create a local instance of the package
$: npm link
  1. Now install the app you're using flagpack in, for this instance we'll be using a Svelte template app:
$: npx degit sveltejs/template my-svelte-project
  1. use cd to move into the app directory and use npm link to add your local instance of svelte-flagpack
# move into directory
$: cd my-svelte-project

# add local instance of svelte-flagpack
$: npm link svelte-flagpack
  1. Now in the svelte-flagpack run the dev script so your changes are updated automatically
$: npm run dev
  1. You're now ready to go to develop on the svelte-flagpack package!

Building the package

Building the package should only ever be needed if there are changes from the flagpack-core devDependency. svelte-flagpack will be built based on the CountryCodeList.json in flagpack-core.

To build svelte-flagpack go through the following steps:

  1. Update flagpack-core to the latest version
  2. Run the build script in svelte-flagpack
$: npm run build

Releasing

If you have proper credentials, like a @yummygum team member, you can release a new version of svelte-flagpack.

To release a new version you'll need to make sure all changes commits are done and pushed. Please follow the semver guidelines to decide what kind of release type your changes would translate to.

$: npm version <release_type>

This will update the version number in the package.json, and will add a git tag automatically. Next you'll need to push the git tag to the remote.

$: git push --tags origin main

After that you'll need to publish to npm.

$: npm publish

When you're confident with the release, make sure the version tag is also released at GitHub.

Follow these steps to get your code PR-ready:

  • Make sure your code is linted and formatted nicely according to the style guide
  • Create a PR and mention what changes you made