Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

78 lines (52 loc) · 3.75 KB
Raw

Contributing to Oculr

We warmly welcome any community contributions to this repository. As a contributor here are some helpful guidelines.

Code of Conduct

Help us ensure a welcoming and inspiring community. Please read our Code of Conduct.

Found a bug?

If you've discovered a bug you can submit an issue, or skip straight to creating a pull request.

Missing feature?

We can't wait to hear about your new ideas. Please consider the size of the feature you're proposing before taking your next steps.

Small - You can submit an issue, or just create a pull request.

Large - Please detail an issue so that it can be discussed. This gives us a chance to make sure we can coordinate the changes and helps ensure the easiest path forward for your changes.

Submitting a PR

  1. It's always good to double check existing PRs to avoid duplicating effort.

  2. Please sign our CLA before creating a PR. This is required for us to accept your changes.

  3. Fork the repo.

  4. Clone the newly forked repo under your account.

    git clone https://github.com/your-account/oculr-ngx.git

  5. Create a new branch for your changes.

    git checkout -b your-new-branch-name

  6. Make your changes, including any related testing and documentation. See our coding standards for more details.

  7. Run the full test suite.

    npm run test

  8. Commit your changes using a descriptive commit message following our message conventions. We use these commit messages when generating release notes.

    git add --all
git commit -m "<type>: <short summary>"
                  |           |
                  |           └─> present tense, lower case, and no period at end
                  |
                  └─> feature|fix|test|docs|refactor|ci

  9. Push your branch to GitHub

    git push -u origin your-new-branch-name

  10. In GitHub create a pull request to oculr:main.

  11. Respond to feedback provided on the PR.

Coding standards

  • We recommend using the following extensions to help ensure a quick PR.
  • All changes must have at least one unit test
  • All changes that change the public API must have documentation

Signing the CLA

Before we can accept your contribution, we require that you sign our Contributor License Agreement (CLA). The process is automated via our pull request flow. Upon submitting your PR, our GitHub bot will determine whether or not you've previously signed our CLA. If you have not, it will provide a link for you to review. Once you have, you have two choices:

  1. Accept the agreement by directing a comment to our bot - @progressive-open-source I accept. Your answer will be recorded and your PR can move forward. You won't have to repeat the process for future submissions unless the agreement has been updated.
  2. Reject the agreement by directing a comment to our bot - @progressive-open-source I reject. Your answer will be recorded and your PR will be blocked from moving forward. You can always accept the agreement later if you change your mind.