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

add contribution file #1373

Merged
merged 16 commits into from
Apr 18, 2023
Merged

add contribution file #1373

merged 16 commits into from
Apr 18, 2023

Conversation

joshua-kim
Copy link
Contributor

@joshua-kim joshua-kim commented Apr 17, 2023

Why this should be merged

Adds a contribution guideline file

How this works

Adds some guidelines for community contributions

How this was tested

N/A

@joshua-kim joshua-kim marked this pull request as ready for review April 17, 2023 20:59
@joshua-kim joshua-kim self-assigned this Apr 17, 2023
@joshua-kim joshua-kim added the documentation Improvements or additions to documentation or examples label Apr 17, 2023
@joshua-kim joshua-kim added this to the v1.10.1 milestone Apr 17, 2023
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Contributor

@exdx exdx left a comment

Choose a reason for hiding this comment

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

Nice! Just some general feedback. I have written several of these contributing guides at my last job so I have some experience.


### Did you fix whitespace, format code, or make a purely cosmetic patch?

- Changes from the community that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of `avalanchego` will generally not be accepted.
Copy link
Contributor

Choose a reason for hiding this comment

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

how come this is the case? I think small formatting commits could be helpful?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wanted to avoid unnecessary noise prs (rearranging the readme, reformatting whitespace, etc). I'm down to not include this on the first pass of this if people dont like this

CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved

### Do you want to contribute to the Avalanche documentation?

- Please check out the `avalanche-docs` repository [here](https://github.com/ava-labs/avalanche-docs).
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we could mention the Avalanche dev call as an additional resource for those interested in contributing? Date/time/etc

Copy link
Contributor Author

@joshua-kim joshua-kim Apr 18, 2023

Choose a reason for hiding this comment

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

waiting to hear back from gabriel on what the link to the call is since it's not on my calendar but we can prob merge this in as-is and add this later whenever i hear back

CONTRIBUTING.md Show resolved Hide resolved
Copy link
Contributor

@StephenButtolph StephenButtolph left a comment

Choose a reason for hiding this comment

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

small formatting nits

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
joshua-kim and others added 8 commits April 18, 2023 13:39
Co-authored-by: Stephen Buttolph <stephen@avalabs.org>
Co-authored-by: Stephen Buttolph <stephen@avalabs.org>
Co-authored-by: Stephen Buttolph <stephen@avalabs.org>
Co-authored-by: Stephen Buttolph <stephen@avalabs.org>
Co-authored-by: Stephen Buttolph <stephen@avalabs.org>
Co-authored-by: Stephen Buttolph <stephen@avalabs.org>
Co-authored-by: Stephen Buttolph <stephen@avalabs.org>
@StephenButtolph StephenButtolph merged commit b9d8508 into ava-labs:dev Apr 18, 2023
@joshua-kim joshua-kim deleted the contributing branch April 18, 2023 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation or examples
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants