Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CONTRIBUTING.md #1062

Merged
merged 4 commits into from
Nov 6, 2023
Merged

Create CONTRIBUTING.md #1062

merged 4 commits into from
Nov 6, 2023

Conversation

jfkhoury
Copy link
Contributor

Description

More to come, the first stab at a contribution model that applies to internal and external contributors.

Motivation and Context

We need our contribution model to be crystal clear.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (non-breaking change which does not add functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA or I'm an Adobe employee.
  • I have made any necessary test changes and all tests pass.
  • I have run the Sandbox successfully.

@carterworks
Copy link
Contributor

Is there value in including instruction on our testing and code quality standards?

It needs to:

  • have functional (and maybe unit tests)
  • have been tested on alloyio.com and maybe another page, and
  • (maybe) include a page on the sandbox or a demo in github.com/adobe/alloy-samples
  • Pass formatting and usage standards (npm run format and npm run lint)

@jfkhoury
Copy link
Contributor Author

Is there value in including instruction on our testing and code quality standards?

It needs to:

  • have functional (and maybe unit tests)
  • have been tested on alloyio.com and maybe another page, and
  • (maybe) include a page on the sandbox or a demo in github.com/adobe/alloy-samples
  • Pass formatting and usage standards (npm run format and npm run lint)

Yes, absolutely! Thank you for the suggestions, I will make the change.

Copy link
Contributor

@jonsnyder jonsnyder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it!

@jfkhoury
Copy link
Contributor Author

jfkhoury commented Nov 6, 2023

@carterworks It turned out I did mention the functional tests and sandbox. Can you re-review, please so I can merge this version? Thanks!

@jfkhoury jfkhoury merged commit 5ffafb3 into main Nov 6, 2023
1 check passed
@jfkhoury jfkhoury deleted the contribution-process branch November 6, 2023 19:00
@carterworks carterworks added the ignore-for-release Do not include this PR in release notes label Nov 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore-for-release Do not include this PR in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants