forked from SpartnerNL/Laravel-Excel
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move docs from readme to docs + add new issue/PR templates
- Loading branch information
1 parent
7b62745
commit 589f0f3
Showing
20 changed files
with
576 additions
and
499 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,50 @@ | ||
<!-- | ||
Have you read Laravel-Excel's | ||
[contributing guidelines](https://laravel-excel.maatwebsite.nl/docs/3.0/getting-started/contributing) | ||
and [Code Of Conduct](https://github.com/Maatwebsite/Laravel-Excel/blob/3.0/CODE_OF_CONDUCT.md)? | ||
By filing an Issue, you are expected to comply with it, including treating everyone with respect. | ||
Filling out the template is required. Any issue that does not include enough information may be closed at the maintainers' discretion. | ||
Please prefix your issue with one of the following: [BUG] [PROPOSAL] [QUESTION]. | ||
### Package version, Laravel version | ||
--> | ||
|
||
### Prerequisites | ||
|
||
<!-- | ||
Put an X between the brackets if you have done all of the following: | ||
--> | ||
|
||
* [ ] Able to reproduce the behaviour outside of your code. | ||
* [ ] Checked that your issue isn't already filed. | ||
* [ ] Checked if no PR was submitted that fixes this problem. | ||
|
||
### Versions | ||
|
||
* PHP version: | ||
* Laravel version: | ||
* Package version: | ||
|
||
### Description | ||
|
||
<!-- Describe the issue --> | ||
|
||
### Steps to Reproduce | ||
|
||
<!-- How can this issue be reproduced? Provide an excel file or reproduction repository to help us reproduce the issue easily. --> | ||
|
||
**Expected behavior:** | ||
|
||
### Expected behaviour | ||
<!-- What you expect to happen --> | ||
|
||
### Actual behaviour | ||
**Actual behavior:** | ||
|
||
#### Exception stack trace | ||
<!-- What actually happens. Please include screenshots, strack traces and anything that can help us understand the issue. --> | ||
|
||
#### Screenshot of Excel file | ||
### Additional Information | ||
|
||
### Steps to reproduce the behaviour | ||
Any additional information, configuration or data that might be necessary to reproduce the issue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
### Requirements | ||
|
||
Please take note of our contributing guidelines: https://laravel-excel-docs.dev/docs/3.0/getting-started/contributing | ||
Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion. | ||
|
||
Mark the following tasks as done: | ||
|
||
* [ ] Check the codebase to ensure that your feature doesn't already exist. | ||
* [ ] Check the pull requests to ensure that another person hasn't already submitted the feature or fix. | ||
* [ ] Documentation was adjusted | ||
* [ ] Tests were added to ensure against regression. | ||
|
||
### Description of the Change | ||
|
||
<!-- | ||
We must be able to understand the design of your change from this description. | ||
If we can't get a good idea of what the code will be doing from the description here, | ||
the pull request may be closed at the maintainers' discretion. | ||
Keep in mind that the maintainer reviewing this PR may not be familiar with or have | ||
worked with the code here recently, so please walk us through the concepts. | ||
--> | ||
|
||
### Why Should This Be Added? | ||
|
||
<!-- Explain why this functionality should be added in Laravel-Excel --> | ||
|
||
### Benefits | ||
|
||
<!-- What benefits will be realized by the code change? --> | ||
|
||
### Possible Drawbacks | ||
|
||
<!-- What are the possible side-effects or negative impacts (e.g. breaking changes) of the code change? --> | ||
|
||
### Verification Process | ||
|
||
<!-- | ||
What process did you follow to verify that your change has the desired effects? | ||
- How did you verify that all new functionality works as expected? | ||
- How did you verify that all changed functionality works as expected? | ||
- How did you verify that the change has not introduced any regressions? | ||
--> | ||
|
||
### Applicable Issues | ||
|
||
<!-- Enter any applicable Issues here --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# 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, gender identity and expression, level of experience, 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 [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems 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 [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Contributing | ||
|
||
Please read and understand the contribution guide before creating an issue or pull request. | ||
|
||
## Links | ||
|
||
- Docs: [https://laravel-excel.maatwebsite.nl] | ||
- Issue tracker: [https://github.com/Maatwebsite/Laravel-Excel/issues] | ||
- Support: [https://laravel-excel-docs.dev/docs/3.0/getting-started/support] | ||
|
||
## Etiquette | ||
|
||
This project is an open source project, and as such, the maintainers use their free time to build and maintain it. | ||
The code is freely available and can be used, forked and modified. | ||
|
||
Please be considerate towards maintainers when raising issues or presenting pull requests. | ||
|
||
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient | ||
quality to benefit the project. Many developers have different skill sets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used. | ||
|
||
## Viability | ||
|
||
When requesting or submitting new features, first consider whether it might be useful to others. Open | ||
source projects are used by many developers, who may have entirely different needs to your own. Think about | ||
whether or not your feature is likely to be used by other users of the project. | ||
|
||
## How to submit changes? | ||
|
||
- Check the codebase to ensure that your feature doesn't already exist. | ||
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix. | ||
- Use the [pull request template](https://github.com/Maatwebsite/Laravel-Excel/blob/3.0/.github/PULL_REQUEST_TEMPLATE.md) | ||
|
||
## How to report a bug? | ||
|
||
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident. | ||
- Check to make sure your feature suggestion isn't already present within the project. | ||
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress. | ||
- Check the pull requests tab to ensure that the feature isn't already in progress. | ||
- Use the [issue template](https://github.com/Maatwebsite/Laravel-Excel/blob/3.0/.github/ISSUE_TEMPLATE.md) | ||
|
||
## Requirements | ||
|
||
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)**. - Style will get automatically fixed by StyleCI. | ||
- **Add tests backing up your change!** - You can run the test by running `vendor/bin/phpunit` | ||
- **Document any change in behaviour** - Documentation is located in the `/docs/` folder | ||
- **One feature per Pull Request** | ||
- **Add meaningful commit messages** |
Oops, something went wrong.