This document has the goal to support our community with best practices of open source contribution. You're welcome to improve the document as well!
Table of Contents
- IO Apps
- LTS Policy
- Code of Conduct
- Caught a bug?
Store is a base structure to any store that will be build using VTEX render.
Store GraphQL is a middleware to access all VTEX APIs.
Dreamstore is our IO base store.
Dreamstore Component Apps
- Category Menu
- Product Summary
- Search Result
- Product Details
- Product Kit
Sorry, working in progress
We strongly recommend you create your own branch before submitting a pull request. 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 keeps the following syntax:
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 :)
Suppose you want to fix the rendering pipeline, your PR should be called something along the lines of
Please adhere to using a
kebab-caseformat for your Pull Requests
We kindly ask that if you feel a certain app requires an enhacement or improvement of sorts, that your first open an issue and describe your thoughts and specific needs. We want to work alongside to define the right approach for your problem.
Once we settle on a solution for your issue, you can submit the code patch for review. We use an template for ou PRs process. Follow the instructions and let us know if you have any problem.
How to create a Pull Request
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.
IMPORTANT: Create a workspace with your proposal changes and add the link in PR description. This way we can see if everything is fine.
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;
To keep track of changes between versions, we use
CHANGELOG.md. We follow the standards of Keep a Changelog. Please, always add a changelog to your pull requests. Feel free to refer to
CHANGELOG.md file for more information. Add your changes bellow the tag
How to Create a Release
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
releasy, just go to the repo's root folder and type
releasy patch stable
To release a
Code of Conduct
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
Caught a bug?
Please let us know in the projects issues page, or create a pull request!