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

Hacktoberfest 2017 - Looking for contributions #486

Closed
MinnDevelopment opened this Issue Sep 29, 2017 · 3 comments

Comments

Projects
None yet
2 participants
@MinnDevelopment
Collaborator

MinnDevelopment commented Sep 29, 2017

It is that time of the year again. From the 1st October to the 31st October JDA will be open for Pull Requests contributing to the Hacktoberfest!
Now before you start going we have some rules for this event in order to avoid spam and bad pull requests.

Rules

Before you start making changes please view our CONTRIBUTING.md and our wiki pages for contributing: Contributing & JDA Structure Guide.

  • We are not interested in Pull Requests that change a few typos in documentation or symbol names.
  • We do not want any Pull Requests that are breaking (renaming of classes, methods, etc.)
  • Pull Requests that are obviously split up to farm will not be accepted and marked as invalid (For example changing docs of 2 classes in 2 Pull Requests is not wanted)

Once you have opened your Pull Requests we might review and request changes. If no response is given we will mark your PR as invalid and close it. Please keep track of our review process.

What we are looking for

Updates and improvements to the documentation of JDA are always welcome and we are hoping for a lot of contributions in that direction. Code changes are welcome as long
as it is not a breaking change.

Please open all hacktoberfest pull requests with the base of the hacktoberfest branch and target that same branch.

  • The documentation of event classes is in need of updates in both method documentation and class-level documentation (excludes all message events such as MessageReceivedEvent and similar)
  • Some classes have very brief documentation that can be improved to make the use of it more clear (for instance OrderAction implementations need better class-level docs)
  • Some smaller wrapper classes might need more information on certain features. This may include Presence#setIdle or MessageReaction#getEmote and others.
  • We are planning to rewrite our managers to be used like current RestAction extensions like ChannelAction or similar (this one is really big and a lot of work)
  • We need templates for issues and pull requests to improve contributions and issue tracking for the future ( #493 )

Notes

Before you start making changes please look at already existing Pull Requests and avoid making duplicates. We recommend commenting on this issue about changes that you are currently working on
to inform other contributors about already in-progress changes. You should also look for any comments yourself that might already be claiming what you want to work on.

@MinnDevelopment MinnDevelopment self-assigned this Sep 29, 2017

@kantenkugel kantenkugel self-assigned this Sep 29, 2017

@kantenkugel

This comment has been minimized.

Show comment
Hide comment
@kantenkugel

kantenkugel Sep 29, 2017

Collaborator

Also: for code changes (additions, functionality changes), please talk to us first. we don't want you to have a lot of work when we wouldn't merge it anyway (because its already in the works or we don't want some particular feature)

Collaborator

kantenkugel commented Sep 29, 2017

Also: for code changes (additions, functionality changes), please talk to us first. we don't want you to have a lot of work when we wouldn't merge it anyway (because its already in the works or we don't want some particular feature)

@kantenkugel

This comment has been minimized.

Show comment
Hide comment
@kantenkugel

kantenkugel Sep 29, 2017

Collaborator

Oh and don't forget to sign up at the Hacktoberfest website first, if you want your reward (link in original post)

Collaborator

kantenkugel commented Sep 29, 2017

Oh and don't forget to sign up at the Hacktoberfest website first, if you want your reward (link in original post)

@MinnDevelopment

This comment has been minimized.

Show comment
Hide comment
@MinnDevelopment

MinnDevelopment Nov 2, 2017

Collaborator

Thank you for your contributions, we closed this with 7 PRs marked as hacktoberfest PRs.

Collaborator

MinnDevelopment commented Nov 2, 2017

Thank you for your contributions, we closed this with 7 PRs marked as hacktoberfest PRs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment