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

[tracking] issue for Block Elements #61

Closed
19 tasks done
cakekindel opened this issue Jul 3, 2020 · 0 comments
Closed
19 tasks done

[tracking] issue for Block Elements #61

cakekindel opened this issue Jul 3, 2020 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@cakekindel
Copy link
Owner

cakekindel commented Jul 3, 2020

What this is

One of the next big steps for this library will be implementing Block Elements so consumers
can enable interactivity with their slack apps - if you're interested in helping contribute to this library,
start here or with the tracking issue for Composition Objects (#63)

How to contribute

  • If a Child Issue doesn't have an issue associated, create one like this (Button block element #62)
    • if you can, use the issue to workshop the structure and API before diving in!
  • If a Child Issue exists, and is not yet implemented or spoken for:
    • comment on the issue that you would like to work on it (that way nobody else accidentally does)
    • fork this repo
    • implement the feature on your fork
    • open a pull request closing the child issue.
    • for some closer guidance, feel free to reach out, or check out the commit history on this PR. It is a solid example of my personal process.

Must-haves for PRs

  • A corresponding JSON smoke test
  • Copied + formatted documentation from the [Block Element]s Slack API Docs
  • (If applicable) Runtime validation that matches any length limits or similar requirement
  • (If applicable) Runtime validation tests that exercise each model requirement

Nice-to-haves for PRs

  • A method-based API that abstracts the fields away from library users, meaning:
    • A constructor with all required fields as parameters
      • e.g. fn from_field_a_and_field_b(field_a: A, field_b: B) -> Self
    • Setter methods for all optional fields
      • e.g. fn with_field_c(mut self, field_c: C) -> Self

Child Issues

@cakekindel cakekindel added the help wanted Extra attention is needed label Jul 3, 2020
@cakekindel cakekindel added this to the Block Elements milestone Jul 3, 2020
@cakekindel cakekindel pinned this issue Jul 3, 2020
@cakekindel cakekindel added the good first issue Good for newcomers label Jul 3, 2020
@cakekindel cakekindel added the enhancement New feature or request label May 17, 2021
@cakekindel cakekindel unpinned this issue May 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant