From ca5bcbfaf11310176d39c78d2f7f977c54caf803 Mon Sep 17 00:00:00 2001 From: Akshay Nair Date: Tue, 6 Oct 2020 14:00:31 +0530 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..2a3e7da99 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing +When contributing to this repository, please first discuss the change you wish to make via issue before making a change. + +You should also read up on this project's [code of conduct](./CODE_OF_CONDUCT.md) + +## Pull requests +You can create an pull request for the following reasons - +* Adding, changing or removing a domain file you own +* Fixing a bug in the scripts or CI +* Fix an error in the documentation + +#### Domains +Changes to domain files will follow the given process - +* PR will be reviewed and merged to `main` branch +* Currently, the publishing of records is done manually. This will be automated soon with releases +* The changes should reflect soon after publishing + + +## Issues +* **Report an abusive domain** - Create a new issue with the label `report-abuse` +* **Report a problem with your domain** - Create a new issue with the label `support` +* **Suggestions** - Create a new issue with the label `suggestion` +* **For any questions** - Create a new issue with the label `question` +* **Report any other issues related to this repository** - Create a new issue with any label that fits