Contributing

Code of Conduct

We has adopted the Contributor Covenant as our Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.

Open Development

All work on VUtil happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.

Semantic Versioning

VUtil follows semantic versioning. We release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes. When we make breaking changes, we also introduce deprecation warnings in a minor version so that our users learn about the upcoming changes and migrate their code in advance.

Every significant change is documented in the changelog file.

Release Schedule

todo

Branch Organization

Submit all changes directly to the main branch. We don’t use separate branches for development or for upcoming releases. We do our best to keep main in good shape, with all tests passing.

Code that lands in main must be compatible with the latest stable release. It may contain additional features, but no breaking changes. We should be able to release a new minor version from the tip of main at any time.

Bugs

We are using GitHub Issues for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist.

We have already prepared issue templates for bug reports and feature requests. If you want to fire an issue, just enter the New issue page and select either of them to get started. The best way to get your bug fixed is by using our issue template and provide reproduction steps with this template.

Proposing a Change

If you intend to change the public API, or make any non-trivial changes to the implementation, we recommend filing an issue, or just enter the New issue page and select either of them to get started.

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.

Your First Pull Request

Working on your first Pull Request? You can learn how from this free video series:How to Contribute to an Open Source Project on GitHub

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started.

If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort.

If somebody claims an issue but doesn’t follow up for more than two weeks, it’s fine to take it over but you should still leave a comment.

Sending a Pull Request

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. We’ll do our best to provide updates and feedback throughout the process.

Before submitting a pull request, please make sure the following is done:

1. Fork the repository and create your branch from main.
2. (If rush has been install, just go to step 3) global install @microsoft/rush：npm i --global @microsoft/rush.
3. Run rush update --full in the repository root.
4. If you’ve fixed a bug or added code that should be tested, add tests!
5. Ensure the test suite passes (rush test). Tip: rush test -- --watch TestName is helpful in development.
6. Make sure your code lints (rush lint). Tip: Lint runs automatically when you git commit (Use Git Hooks).
7. Run rush compile for typecheck.

Development Workflow

After cloning VUtil, run rush update --full to fetch its dependencies. Then, you can run several commands:

1. rush eslint checks the code style.
2. rush test runs the complete test suite.
3. rush run -p <project_name> -s <script> run the specified script for the specified project, eg. rush run -p @visactor/vutils -s test
4. rush prettier --dir <project_relative_path> --ext <file_type> prettier the specified script for the specified project, eg. rush prettier --dir packages/v-util --ext ts

License