You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

CONTRIBUTING.md 1.8 kB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. # Contributing
  2. Discord.Net is an open-source project, and we appreciate any and all
  3. contributions made by our community. However, please conform to the
  4. following guidelines when possible:
  5. ## Development Cycle
  6. We prefer all changes to the library to be discussed beforehand,
  7. either in a GitHub issue, or in a discussion in our Discord channel
  8. with library regulars or other contributors.
  9. Issues that are tagged as "up for grabs" are free to be picked up by
  10. any member of the community.
  11. ### Pull Requests
  12. We prefer pull-requests that are descriptive of the changes being made
  13. and highlight any potential benefits/drawbacks of the change, but these
  14. types of write-ups are not required. See this [merge request](https://github.com/RogueException/Discord.Net/pull/793)
  15. for an example of a well-written description.
  16. ## Semantic Versioning
  17. This project follows [Semantic Versioning](http://semver.org/). When
  18. writing changes to this project, it is recommended to write changes
  19. that are SemVer compliant with the latest version of the library in
  20. development.
  21. The working release should be the latest build off of the `dev` branch,
  22. but can also be found on the [development board](https://github.com/RogueException/Discord.Net/projects/1).
  23. We follow the .NET Foundation's [Breaking Change Rules](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/breaking-change-rules.md)
  24. when determining the SemVer compliance of a change.
  25. Obsoleting a method is considered a **minor** increment.
  26. ## Coding Style
  27. We attempt to conform to the .NET Foundation's [Coding Style](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/coding-style.md)
  28. where possible.
  29. As a general rule, follow the coding style already set in the file you
  30. are editing, or look at a similar file if you are adding a new one.