Browse Source

Add section on contributing

Bruce Marriner 9 years ago
parent
commit
6000da7674
1 changed files with 13 additions and 0 deletions
  1. 13 0
      README.md

+ 13 - 0
README.md

@@ -42,6 +42,19 @@ discord, err := discordgo.New("username", "password")
 See Documentation and Examples below for more detailed information.
 
 
+## Contributing
+Contributions are very welcomed, however please follow the below guidelines.
+
+- First open an issue describing the bug or enhancement so it can be
+discussed.  
+- Fork the develop branch and make your changes.  
+- Try to match current naming conventions as closely as possible.  
+- This package is intended to be a low level direct mapping of the Discord API 
+so please avoid adding enhancements outside of that scope without first 
+discussing it.
+- Create a Pull Request with your changes against the develop branch.
+
+
 ## Documentation
 
 **NOTICE** : This library and the Discord API are unfinished.