Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) · 1.09 KB
Raw

RedditSharp is OSS

First, thank you for your interest! Contributions are an essential part of the open-source design, and always appreciated. These might include:

  • Bug reports
  • Suggestions
  • Pull requests for patches and features
  • Interest in becoming a maintainer or key developer

Guidelines

RedditSharp uses Git, specifically GitHub, to handle contributions and changes. To contribute a patch or feature, follow the Github Flow.

In summary:

  1. Fork the repo
  2. Branch the repo
  3. Update documentation if necessary
  4. Comment on your code
  5. Verify that your code is correctly formatted (using Prettier)
  6. Create your PR

If you're submitting an issue, the provided templates are a good guideline to ensure it will be addressed. Bug reports should always be submitted as an issue.

Licensing

This project is licensed under CC BY-NC-ND 4.0.

By contributing to this project, this code will fall under the aformentioned license; incompatible code shouldn't be submitted.