You can contribute to VTEX IO by creating an issue or making a pull request. Pull requests can contain changes in the code, but changes in documentation are also welcome and appreciated! :)
We kindly ask that you first create your branch before submitting a PullRequest. We follow a strict branch naming convention that makes it easier for the project maintaners to keep track of the repository.
Our branch naming convention maintains the following syntax:
(fix|feature|refactor)/
The first seperator should define if your PR is a fix, feature or refactor.
The second seperator contains the name of your branch. Try not to get too creative :)
Example:
Suppose you want to fix the rendering pipeline, your PR should be called something along the lines of fix/rendering-pipeline
Please adhere to using a
snake-likeformat for your Pull Requests
To keep track of changes between versions, we use CHANGELOG.md. Please, always add a changelog to your pull requests. Feel free to refer to CHANGELOG.md file for more information
Creating a pull request is pretty straight forward. Just add and commit your unstaged changes and push them. Next, create a pull request with a short and objective description of the problem and how your fix solves it.
Also, before creating a pull request, make sure your changes follow and pass our linting rules. To test your linter, go to the repo's main folder and type
cd node;
rm -rf node_modules;
yarn && yarn lint;After your PR (pull request) has been accepted, you are able to release it. This repo uses the releasy npm tool for this purpose.
releasy is a SemVer aware tool that changes the app's version accordingly.
To release a new patch with releasy, just go to the repo's root folder and type
releasy patch stableTo release a beta patch:
releasy patch