diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000000..f02d83fa7f7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** + + +**To Reproduce** + +Steps to reproduce the behavior: + +1. + +**Expected behavior** + + + +**Details** + + - Operating system: + - Node version: + +**Additional context** + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000000..0ac6b3c416b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,24 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: feature-request +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** + + + +**Describe the solution you'd like** + + + +**Describe alternatives you've considered** + + + +**Additional context** + + diff --git a/README.md b/README.md index 6aea8b4de6d..c6134c6f051 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,34 @@ To learn more about ATP, see: - [Overview Guide](https://atproto.com/guides/overview) 👈 Good place to start - The [Blogpost on self-authenticating data structures](https://blueskyweb.xyz/blog/3-6-2022-a-self-authenticating-social-protocol) +## Rules & Guidelines + +While we do accept contributions, we prioritize high quality issues and pull requests. Adhering to the below guidelines will ensure a more timely review. + +### Rules: + +- We may not respond to your issue or PR. +- We may close an issue or PR without much feedback. +- We may lock discussions or contributions if our attention is getting DDOSed. + +### Guidelines: + +- Check for existing issues before filing a new one please. +- Open an issue and give some time for discussion before submitting a PR. +- If submitting a PR that includes a lexicon change, please get sign off on the lexicon change _before_ doing the implementation +- Issues are for bugs & feature requests related to the Typescript implementation of atproto and related services. For high level discussions, please you the [Discussion Forum](https://github.com/bluesky-social/atproto/discussions). For client issues please use the relevenant [social-app](https://github.com/bluesky-social/social-app) repo +- Stay away from PRs that: + - Refactor large parts of the codebase + - Add entirely new features without prior discussion + - Change the tooling or frameworks used without prior discussion + - Introduce new unnecessary dependencies + +Remember, we serve a wide community of users. Our day to day involves us constantly asking "which top priority is our top priority." If you submit well-written PRs that solve problems concisely, that's an awesome contribution. Otherwise, as much as we'd love to accept your ideas and contributions, we really don't have the bandwidth. + +## Security disclosures + +If you discover any security issues, please send an email to security@bsky.app. The email is automatically CCed to the entire team and we'll respond promptly. See [SECRUITY.md](https://github.com/bluesky-social/atproto/blob/main/SECURITY.md) for more info. + ## License MIT License