We are excited that you are interested in contributing to Vuesax. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.
We have adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
All work on Vuesax happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.
We are using GitHub Issues for bug tracing.
If you intend to change the public API, or make any non-trivial changes to the implementation, we recommend filing an issue. This lets us reach an agreement on your proposal before you put significant effort into it.
If you’re only fixing a bug, it’s fine to submit a pull request right away, but we still recommend to file an issue detailing what you’re fixing. This is helpful in case we don’t accept that specific fix but want to keep track of the issue.
The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation.
Before submitting a pull request, please make sure the following is done:
npm installin the repository root.
After cloning Vuesax, run
npm install to fetch dependencies and Vuepress. Then, you can run several commands:
npm run devruns Vuesax website locally.
npm run buildto build.