From ba83ab2e67f51c295f0b174e65b154e55a0bcf8f Mon Sep 17 00:00:00 2001 From: Shivam Mathur Date: Sun, 22 Sep 2019 12:16:51 +0530 Subject: [PATCH] Add templates and format code --- .github/CODE_OF_CONDUCT.md | 76 +++++++++++++++++++ .github/CONTRIBUTING.md | 54 +++++++++++++ .github/PULL_REQUEST_TEMPLATE/FAILING_TEST.md | 9 +++ .github/PULL_REQUEST_TEMPLATE/FIX.md | 9 +++ .github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md | 9 +++ .github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md | 9 +++ docs/contributors.md | 3 - src/features.ts | 3 +- 8 files changed, 167 insertions(+), 5 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/FAILING_TEST.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/FIX.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md delete mode 100644 docs/contributors.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..d398bb44 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at contact@shivammathur.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..1ba7b207 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,54 @@ +# Contributing to setup-php + +## Contributor Code of Conduct + +Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. + +## Workflow + +* Fork the project. +* Make your bug fix or feature addition. +* Add tests for it. This is important so we don't break it in a future version unintentionally. +* Send a pull request to the develop branch. + +Please make sure that you have [set up your user name and email address](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup) for use with Git. Strings such as `silly nick name ` look really stupid in the commit history of a project. + +Due to time constraints, you may not always get a quick responce. Please do not take delays personal and feel free to remind me. + +## Coding Guidelines + +This project comes with a `.prettierrc.json` configuration file. Please run the following command to format the code before commiting it. + +```bash +$ npm run format +``` + +## Using setup-php from a Git checkout + +The following commands can be used to perform the initial checkout of setup-php: + +```bash +$ git clone https://github.com/shivammathur/setup-php.git + +$ cd setup-php +``` + +Install setup-php dependencies using [npm](https://www.npmjs.com/): + +```bash +$ npm install +``` + +## Running the test suite + +After following the steps shown above, The `setup-php` tests in the `__tests__` directory can be run using this command: + +```bash +$ npm test +``` + +## Reporting issues + +Please submit the issue using the appropiate template provided for a bug report or a feature request: + +* [Issues](https://github.com/shivammathur/setup-php/issues) \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/FAILING_TEST.md b/.github/PULL_REQUEST_TEMPLATE/FAILING_TEST.md new file mode 100644 index 00000000..a2d36fbe --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/FAILING_TEST.md @@ -0,0 +1,9 @@ +--- +name: 🐞 Failing Test +about: You found a bug and have a failing test? +labels: bug +--- + + diff --git a/.github/PULL_REQUEST_TEMPLATE/FIX.md b/.github/PULL_REQUEST_TEMPLATE/FIX.md new file mode 100644 index 00000000..4508a07b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/FIX.md @@ -0,0 +1,9 @@ +--- +name: 🐞 Bug Fix +about: You have a fix for a bug? +labels: bug +--- + + diff --git a/.github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md b/.github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md new file mode 100644 index 00000000..c7792f77 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md @@ -0,0 +1,9 @@ +--- +name: ⚙ Improvement +about: You have some improvement to make setup-php better? +labels: enhancement +--- + + diff --git a/.github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md b/.github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md new file mode 100644 index 00000000..b39d753d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md @@ -0,0 +1,9 @@ +--- +name: 🎉 New Feature +about: You have implemented some neat idea that you want to make part of setup-php? +labels: enhancement +--- + + diff --git a/docs/contributors.md b/docs/contributors.md deleted file mode 100644 index 4ebb8c26..00000000 --- a/docs/contributors.md +++ /dev/null @@ -1,3 +0,0 @@ -# Contributors - -Please submit a Pull Request to the develop branch \ No newline at end of file diff --git a/src/features.ts b/src/features.ts index 3d030970..6c4920b5 100644 --- a/src/features.ts +++ b/src/features.ts @@ -180,8 +180,7 @@ export async function addINIValuesWindows( let ini_values: Array = await utils.INIArray(ini_values_csv); await utils.asyncForEach(ini_values, async function(ini_value: string) { // add script to set ini value - script += - 'Add-Content C:\\tools\\php\\php.ini "' + ini_value + '"\n'; + script += 'Add-Content C:\\tools\\php\\php.ini "' + ini_value + '"\n'; }); return script; }