|
|
|
@ -1,46 +1,46 @@
|
|
|
|
# Contributing to OctoberCMS
|
|
|
|
# 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:
|
|
|
|
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.
|
|
|
|
- **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.
|
|
|
|
|
|
|
|
|
|
|
|
- **Request location**: Enter the URL where this bug occurs, if applicable.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- **Reproduce steps**: Clearly mention the steps to reproduce the bug.
|
|
|
|
- **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**.
|
|
|
|
- **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.
|
|
|
|
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.
|
|
|
|
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
|
|
|
|
#### 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
|
|
|
|
## 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
|
|
|
|
#### 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:
|
|
|
|
To help us merge your Pull Request, please make sure you follow these points:
|
|
|
|
|
|
|
|
|
|
|
|
1. Describe the problem clearly in the Pull Request description
|
|
|
|
- Describe the problem clearly in the Pull Request description
|
|
|
|
1. Please make your fix on the `develop` branch. This makes merging much easier.
|
|
|
|
- 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.
|
|
|
|
- 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.
|
|
|
|
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.
|
|
|
|
- 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!
|
|
|
|
Thank you for your contributions!
|
|
|
|
|
|
|
|
|
|
|
|
#### PSR Coding standards
|
|
|
|
#### 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 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)
|
|
|
|
- [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
|
|
|
|
#### Team rules
|
|
|
|
|
|
|
|
|
|
|
|
The October team follows the [developer guidelines](http://octobercms.com/docs/help/developer-guide) as much as possible.
|
|
|
|
The October team follows the [developer guidelines](https://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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### Escalation process
|
|
|
|
#### Escalation process
|
|
|
|
|
|
|
|
|