Skip to content

Latest commit

 

History

History
58 lines (45 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

58 lines (45 loc) · 2.47 KB
Raw

Contributing to DPY Anti-Spam

I love all input, whether its issues or pull requests!

Project management

Github is used to host code, to track issues and feature requests, as well as accept pull requests. Our discord is used for further discussion where required and general team work side of things.

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

I use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Fork & Pull Request to add new code

I love new code for this project, I love seeing it grow. However, there is a process to be followed.

Fork master branch & get coding

Whenever ready, create a pull request & ask for a review from Skelmis

Code will be reviewed, and once it is at a stage where it is approved it will be merged

I have the right to accept/deny any good I feel does not add to this project

Use a Consistent Coding Style

  • Tabs should be 4 spaces for indentation
  • Where applicable, code should be documented. For implementation see the below Documentaion sections
    • Applicable means any public methods
  • All code should be unittested to a level which ensures good future regression tests
    • Code which requires external API's such as MongoDB or Lib impl's require manual testing
  • Where code gets excessive, functional programming ideas should come into play for readability
  • return statements are preferred within conditionals when checking whether to continue with processing or not For example:
if not condtion:
    # This means we should not process the rest of the command
    return await ctx.send("You are missing perms, an argument, etc")

# We should process the rest of the command here

Is preferred over:

if not condtion:
    # This means we should not process the rest of the command
    await ctx.send("You are missing perms, an argument, etc")
else:
    # We should process the rest of the command

Function Documentation

  • All new functions should be documented in accordance with these conventions