diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..bacdb2061 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,5 @@ +# Code of Conduct + +We promise to extend courtesy and respect to everyone opening an issue. We expect anyone using the bug trackers to do the same. + +All reported issues to this project are valuable. Please act with respect and avoid demeaning, condescending, racist, sexist and other inappropriate language and conduct. Please ensure comments stay professional and constructive. \ No newline at end of file diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 53% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md index b6d39bb95..d8d3638a2 100644 --- a/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,46 +1,46 @@ # Contributing to OctoberCMS -Thank you for your contributions! +Thank you for your interest in contributing to the OctoberCMS project! -## Reporting a bug with OctoberCMS +## Reporting an issue with OctoberCMS -**Please don't use the main GitHub for reporting bugs with plugins.** If you have found a bug in a plugin, the best place to report it is with the [plugin author](http://octobercms.com/plugins). +**Please don't use the main GitHub for reporting issues with plugins.** If you have found a bug in a plugin, the best place to report it is with the [plugin author](https://octobercms.com/plugins). We work hard to process bugs that are reported, to assist with this please ensure the following details are always included: -- **Bug summary**: Make sure your summary reflects what the problem is and where it is. - -- **Request location**: Enter the URL where this bug occurs, if applicable. +- **Summary**: Make sure your summary reflects what the problem is and where it is. Provide as much detail as possible, the more information we have to work with the more likely it is that your problem can be solved. - **Reproduce steps**: Clearly mention the steps to reproduce the bug. -- **Expected behavior**: How OctoberCMS should behave on above mentioned steps. +- **Expected behavior**: Describe how OctoberCMS should behave on above mentioned steps. - **Actual behavior**: What is the actual result on running above steps i.e. the bug behavior - **include any error messages**. -#### Here's how to report a bug on GitHub +>**NOTE:** Screenshots and GIFs are very helpful in visuallizing what exactly is going wrong + +#### Here's how to report an issue on GitHub 1. **Register for an account on [GitHub](https://github.com),** if you don't already have one. -2. **Search for similar bugs.** Perhaps someone has already reported your issue! If so, please add clarification and/or more information to the **existing** bug. +2. **Search for similar issues.** Perhaps someone has already reported your issue! If so, please add clarification and/or more information to the **existing** issue. -3. **Create a new bug.** If you don't find any similar issues, you can report your bug via the "new issue" tab once you've logged in. +3. **Create a new issue.** If you don't find any similar issues, you can report your issue via the ["issues" tab](https://github.com/octobercms/october/issues) once you've logged in. -4. **Monitor your issue and respond to questions.** It may be necessary to provide additional information upon request or you might be asked if the bug still occurs after an update. +4. **Monitor your issue and respond to questions.** It may be necessary to provide additional information upon request or you might be asked if the issue still occurs after an update. -5. **Close your bug.** In case you notice that the bug doesn't occur anymore, you can close the issue yourself (don't forget to add a note saying the issue is resolved). +5. **Close your issue.** In case you notice that the issue doesn't occur anymore, you can close the issue yourself (don't forget to add a note saying that the issue is resolved and ideally any additional information on how it was resolved). If you find out your bug is actually a duplicate of another bug and only notice that after you created it, please also close your bug with a short reference to the other issue that was there before. #### Reporting security issues -If you wish to contact us privately about any security exploits in OctoberCMS you may find, you can find our email on the [OctoberCMS website](http://octobercms.com). +If you wish to contact us privately about any security exploits in OctoberCMS you may find, you can find our email on the [OctoberCMS website](https://octobercms.com). ## Feature requests -**Please don't use GitHub issues for suggesting a new feature.** If you have a feature idea, the best place to suggest it is the [OctoberCMS website forum](http://octobercms.com/forum/chan/feature-requests). +**Please don't use GitHub issues for suggesting a new feature.** If you have a feature idea, the best place to suggest it is the [OctoberCMS website forum](https://octobercms.com/forum/chan/feature-requests). -Only use GitHub if you are planning on contributing a new feature and developing it. If you want to discuss your idea first, before "officially" posting it anywhere, you can always join us on [IRC](http://octobercms.com/chat). +Only use GitHub if you are planning on contributing a new feature and developing it. If you want to discuss your idea first, before "officially" posting it anywhere, you can always join us on [IRC](https://octobercms.com/chat) or [Slack](https://octobercms.slack.com). #### GitHub feature requests @@ -54,16 +54,16 @@ Your contributions to the project are very welcome. If you would like to fix a b To help us merge your Pull Request, please make sure you follow these points: -1. Describe the problem clearly in the Pull Request description -1. Please make your fix on the `develop` branch. This makes merging much easier. -1. Do not edit compiled asset files such as `october.css` Instead, try to edit the LESS files inside the `less/` directory and then use a compiler. -1. For any change that you make, **please try to also add a test case(s)** in the `tests/unit` directory. This helps us understand the issue and make sure that it will stay fixed forever. +- Describe the problem clearly in the Pull Request description +- Please make your fix on the `develop` branch. This makes merging much easier. +- Do not edit compiled asset files such as `october.css`, `framework.css`, etc. directly. Instead, edit the LESS files inside the `less/` directory and then run `php artisan october:util compile assets` from the project root and commit the changed LESS files as well as the recompiled asset files. +- For any change that you make, **please also add a test case(s)** in the `tests/unit` directory. This helps us understand the issue and make sure that it will stay fixed forever. Thank you for your contributions! #### PSR Coding standards -Also ensure that your Pull Request satisfies the following coding standards: +Please ensure that your Pull Request satisfies the following coding standards: - [PSR 2 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) - [PSR 1 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md) @@ -71,13 +71,7 @@ Also ensure that your Pull Request satisfies the following coding standards: #### Team rules -The October team follows the [developer guidelines](http://octobercms.com/docs/help/developer-guide) as much as possible. - -#### Code of conduct - -We promise to extend courtesy and respect to everyone opening an issue. We expect anyone using the bug trackers to do the same. - -All reported issues to this project are valuable. Please act with respect and avoid demeaning, condescending, racist, sexist and other inappropriate language and conduct. Please ensure comments stay professional and constructive. +The October team follows the [developer guidelines](https://octobercms.com/docs/help/developer-guide) as much as possible. #### Escalation process diff --git a/.github/ISSUE_TEMPLATES/1_BUG_REPORT.md b/.github/ISSUE_TEMPLATES/1_BUG_REPORT.md new file mode 100644 index 000000000..237547103 --- /dev/null +++ b/.github/ISSUE_TEMPLATES/1_BUG_REPORT.md @@ -0,0 +1,20 @@ +--- +name: "🐛 Bug Report" +about: Report a general OctoberCMS issue +labels: 'Status: Review Needed', 'Type: Unconfirmed Bug' +--- + +- OctoberCMS Build: ### +- PHP Version: +- Database Engine: +- Plugins Installed: + +### Description: + + + + +### Steps To Reproduce: + + + diff --git a/.github/ISSUE_TEMPLATES/2_SUPPORT_QUESTION.md b/.github/ISSUE_TEMPLATES/2_SUPPORT_QUESTION.md new file mode 100644 index 000000000..3ea7271c1 --- /dev/null +++ b/.github/ISSUE_TEMPLATES/2_SUPPORT_QUESTION.md @@ -0,0 +1,12 @@ +--- +name: "⚠️ Support Question" +about: 'This repository is only for reporting bugs or problems. If you need help, see: https://octobercms.com/support' +--- + +This repository is only for reporting bugs or problems. If you need support, please use the following options: + +- Forum: https://octobercms.com/forum +- Slack: https://octobercms.slack.com (Invite link: https://octobercms-slack.herokuapp.com/) +- Stack Overflow: https://stackoverflow.com/questions/tagged/octobercms + +Thanks! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATES/3_FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATES/3_FEATURE_REQUEST.md new file mode 100644 index 000000000..2d1234dec --- /dev/null +++ b/.github/ISSUE_TEMPLATES/3_FEATURE_REQUEST.md @@ -0,0 +1,6 @@ +--- +name: "💡 Feature Request" +about: 'For ideas or feature requests, make a PR or talk to the core members on Slack' +--- + +If you would like to propose new features, please make a pull request. Alternatively, you may message the core team on the OctoberCMS Slack. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATES/4_DOCUMENTATION.md b/.github/ISSUE_TEMPLATES/4_DOCUMENTATION.md new file mode 100644 index 000000000..850a288d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATES/4_DOCUMENTATION.md @@ -0,0 +1,10 @@ +--- +name: "📚 Documentation Issue" +about: 'For documentation issues, see: https://github.com/octobercms/docs/issues' +--- + +The OctoberCMS documentation has its own dedicated repository. Please open your documentation-related issue at https://github.com/octobercms/docs/issues. + +> **NOTE:** Since documentation issues are not reviewed very often, it's best to simply make a pull request to correct the issue you have found!** + +Thanks! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATES/5_SECURITY_ISSUES.md b/.github/ISSUE_TEMPLATES/5_SECURITY_ISSUES.md new file mode 100644 index 000000000..53abbd023 --- /dev/null +++ b/.github/ISSUE_TEMPLATES/5_SECURITY_ISSUES.md @@ -0,0 +1,8 @@ +--- +name: "🔒 Security Vulnerabilities" +about: 'For reporting security-related issues, send an email to hello@octobercms.com' +--- + +PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, SEE BELOW. + +If you discover a security vulnerability within OctoberCMS or dependencies, please send an e-mail to Samuel Georges & Luke Towers via hello@octobercms.com and octobercms@luketowers.ca respectively. All security vulnerabilities will be promptly addressed. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..9e3335ad9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,7 @@ + \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 3d38bebc5..7c2a2c0cf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1 +1 @@ -Changelog can be found here: http://octobercms.com/changelog +View the changelog on the [OctoberCMS website](https://octobercms.com/changelog) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index e30d6fb26..000000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,11 +0,0 @@ -##### Expected behavior -(Describe expected behavior here) - -##### Actual behavior -(Describe actual behavior here) - -##### Reproduce steps -(Describe the steps to reproduce the problem here) - -##### October build -(October build number)