Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

Latest commit

 

History

History
76 lines (53 loc) · 3.4 KB

CONTRIBUTING.md

File metadata and controls

76 lines (53 loc) · 3.4 KB

Contributing to Beagle

Here are a few resources to guide you through contributing to Beagle.

Beagle Pull Request Submission Guidelines

  1. Search for issues and PRs that relates to your submission. You don't want to duplicate effort.
  2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design up front helps to ensure that we're ready to accept your work.
  3. Fork the ZupIT/beagle repo.
  4. Make your changes in a new git branch.
  5. Follow our Coding Rules.
  6. Commit your changes using a descriptive commit message, and make sure to include appropriate test cases.
  7. Push your branch to GitHub.
  8. In GitHub, send a pull request to beagle:main.

After Submitting Pull Request

Choosing a correct Title

They should look like this:

feat: add field in component image to allow resizing

This is a format called conventional commits. It helps us understand what each modification is actually doing, and allow us to automatically generate pretty release notes and versions.

Please read the official specifications for more details.

What types can I use for my PR title?

By "types" we mean the prefix of a commit message like feat:, and they can be one of the following values:

  • feat: a new feature (adding a new component, providing new variants for an existing component, etc.).
  • fix: a bug fix (correcting a styling issue, addressing a bug in a component's API, etc.). When updating non-dev dependencies, mark your changes with the fix: type.
  • docs: documentation-only changes.
  • style: changes that do not affect the meaning of the code (whitespace, formatting, missing semicolons, etc). Not to be used for CSS changes as those are meaningful changes, consider using feat: of fix: instead.
  • refactor: a code change that neither fixes a bug nor adds a feature.
  • perf: a code change that improves performance.
  • test: adding missing tests or correcting existing tests.
  • build: changes that affect the build system (changing webpack or Rollup config for example).
  • ci: changes to our CI configuration files and scripts (changing Fastlane, adding or changing Danger plugins, etc.).
  • chore: other changes that don't modify source or test files. Use this type when adding or updating dev dependencies.
  • revert: reverts a previous commit.

Note: If you're introducing a breaking change, the message body should start with BREAKING CHANGE:

Following changes

After we analyse your contibution, we may comment some questions and suggestions, make sure to:

  • Consider making the required updates.

  • Re-run the Beagle test suites to ensure tests are still passing.

  • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

    git rebase main -i
git push -f

That's it! Thank you for your contribution! 😁

Questions? Head to our FAQ where you might find some answers.

Beagle contribution guidelines

Please refer to beagle's CONTRIBUTING.md for details on our guidelines.