Skip to content

Latest commit

 

History

History
116 lines (76 loc) · 6.71 KB

CONTRIBUTING.md

File metadata and controls

116 lines (76 loc) · 6.71 KB
Raw

Welcome to Fusion Framework contributing guide

Thank you for investing your time in contributing to our project!

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

Issues

Create a new issue

If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes locally

  1. Fork the repository.

  1. Install or update to Node.js, at the version specified in .node-version. For more information, see the development guide.

  2. Create a working branch and start with your changes!

Commit your update

Your commits should adhere to our guidelines and follow a linear history.

Caution

☠️ do not include files in your commit which are outside the scope of the commit!

Important

Don't forget to self-review to speed up the review process⚡️.

Tip

Rebase your commits 😍

The important part is to provide a good history. Git should not be used as a 'backup'. Commit frequency should not be determined by a time etc.

Be smart and think how you would have wanted to visit the history at a later time.

Pull Request

Before open a new PR:

  • all affected packages has matching changesets
  • make sure the the code build pnpm build
  • make sure the code lints pnpm lint
  • make sure tests passes pnpm test run

When you're finished with the changes, create a pull request.

Warning

All PR should be created as draft

when all checks are green, publish the PR

pull request that trigger ready_for_review will post to our Teams channel

Once you submit your PR, a Fusion Core team member will review your proposal. We may ask questions or request additional information.

  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Warning

when a pull request review requests changes, the pull request is moved back to draft

When a pull request is moved back to draft, it is the creator responsibility to request a re-review

Caution

when a pull request review is accepted, the creator is normally responsible for merging in the code.

Tip

Set your PR to "auto-merge"

Your PR is merged!

Congratulations 🎉 The Fusion team thanks you 😘

Windows

This code base can be developed on Windows, however a few potential gotchas need to be kept in mind:

  1. Regular Expressions: Windows uses \r\n for line endings, while Unix-based systems use \n. Therefore, when working on Regular Expressions, use \r?\n instead of \n in order to support both environments. The Node.js os.EOL property can be used to get an OS-specific end-of-line marker.
  2. Paths: Windows systems use \ for the path separator, which would be returned by path.join and others. You could use path.posix, path.posix.join etc and the slash module, if you need forward slashes - like for constructing URLs - or ensure your code works with either.
  3. Bash: Not every Windows developer has a terminal that fully supports Bash, so it's generally preferred to write scripts in JavaScript instead of Bash.
  4. Filename too long error: There is a 260 character limit for a filename when Git is compiled with msys. While the suggestions below are not guaranteed to work and could cause other issues, a few workarounds include:
    • Update Git configuration: git config --system core.longpaths true
    • Consider using a different Git client on Windows