Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (37 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 2.11 KB

Contributing to the log-data-contract template repository

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.

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

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/log-data-contracts.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.

  7. 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

  8. Push your branch to GitHub

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

  9. In GitHub create a pull request to log-data-contracts:main.

  10. Respond to feedback provided on the PR.