diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..c0677df --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,43 @@ +# Introduction + +### Welcome! + +First off, thank you for considering contributing to FHeD! + +### Project philosophy + +Project philosophy goes here + +### Roadmap + +If you want to know more about the project direction or looking for something to work on, checkout the [roadmap](https://github.com/luketainton/FHeD#Roadmap)! +Feel free to open an issue if you have any questions. + +# Ground Rules + +### Code of conduct and guidelines + +First of all, we expect everyone (contributors and maintainers alike) to respect the [Code of conduct](https://github.com/luketainton/FHeD/blob/master/.github/CODE_OF_CONDUCT.md). It is not a recommendation, it is mandatory. + +For all contributions, please respect the following guidelines: + +* Each pull request should implement ONE feature or bugfix. If you want to add or fix more than one thing, submit more than one pull request. +* Do not commit changes to files that are irrelevant to your feature or bugfix (eg: `.gitignore`). +* Do not add unnecessary dependencies. +* Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request. + +# Getting started + +### Discuss about ideas + +If you want to add a feature, it's often best to talk about it before starting working on it and submitting a pull request. It's not mandatory at all, but +feel free to open an issue to present your idea. + +### How to submit a contribution + +The general process to submit a contribution is as follow: +1. Create your own fork of the code +2. Do the changes in your fork +3. Make sure to fill the [pull request description](https://github.com/luketainton/FHeD/blob/master/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md) properly. + +### Happy coding :metal: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 5377b11..a89519f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -3,7 +3,7 @@ name: Feature request about: Suggest an idea for this project title: '' labels: enhancement, question -assignees: +assignees: --- diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 1617cfc..b586407 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -12,7 +12,7 @@ Fixes # (issue) ## Checklist: -- [ ] I read & comply with the [contributing guidelines](https://github.com/bastienwirtz/homer/blob/master/CONTRIBUTING.md) +- [ ] I read & comply with the [contributing guidelines](https://github.com/luketainton/FHeD/blob/master/CONTRIBUTING.md) - [ ] I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers. - [ ] I have made corresponding changes the documentation (README.md). - [ ] I've check my modifications for any breaking change, especially in the `config.yml` file