diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..48fedc9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# How to contribute + +I'm really glad you're reading this, because we need volunteer developers to help this project grow. + + +#### **Did you find a bug?** + +* **Do not open up a GitHub issue if the bug is a security vulnerability**, and instead to refer to our [security policy](./SECURITY.md). + +* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/ramank775/chat-server/issues). + +* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ramank775/chat-server/issues/new). + Be sure to include a **title and clear description**, as much relevant information as possible. + +#### **Did you write a patch that fixes a bug?** + +* Open a new GitHub pull request with the patch. + +* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. + +#### **Do you intend to add a new feature or change an existing one?** + +* Suggest your change in [Ideas in discussion](https://github.com/ramank775/chat-server/discussions/categories/ideas). +* Once approved [open a new issue](https://github.com/ramank775/chat-server/issues/new) and start writing code. + +#### **Do you have questions?** + +* Ask any question about the project on [Q&A in discussion](https://github.com/ramank775/chat-server/discussions/categories/q-a). + +Thanks! :heart: :heart: :heart: + +Raman