|
| 1 | +# Contributing |
| 2 | + |
| 3 | +When contributing to this repository, please first discuss the change you wish to make via issue, |
| 4 | +email, or any other method with the owners of this repository before making a change. |
| 5 | + |
| 6 | +## Getting Started |
| 7 | + |
| 8 | +* Make sure you have a [GitHub account](https://github.com/signup/free) |
| 9 | +* Submit a ticket for your [issue](https://github.com/extcode/cart/issues), assuming one does not already exist. |
| 10 | + * Clearly describe the issue including steps to reproduce when it is a bug. |
| 11 | +* Fork the repository on GitHub |
| 12 | + |
| 13 | +## Making Changes |
| 14 | + |
| 15 | +* Create a topic branch from where you want to base your work. |
| 16 | + * This is usually the master branch. |
| 17 | + * Only target release branches if you are certain your fix must be on that |
| 18 | + branch. |
| 19 | + * To quickly create a topic branch based on master; `git checkout -b |
| 20 | + fix/master/my_contribution master`. Please avoid working directly on the |
| 21 | + `master` branch. |
| 22 | +* Make commits of logical units. |
| 23 | +* Use `./php-cs-fixer fix --config-file Build/.php_cs` to make sure the code is formatted correctly. |
| 24 | +* Make sure your commit messages are in the proper format. Use either `[TASK]`, `[FEATURE]`, `[BUGFIX]` or `[DOC]` |
| 25 | + |
| 26 | +```` |
| 27 | + [TASK] Make the example in CONTRIBUTING imperative and concrete |
| 28 | +
|
| 29 | + The first line is a real life imperative statement. |
| 30 | + The body describes the behavior without the patch, |
| 31 | + why this is a problem, and how the patch fixes the problem when applied. |
| 32 | +
|
| 33 | + Resolves: #123 |
| 34 | +```` |
| 35 | + |
| 36 | +* Make sure you have added the necessary tests for your changes. |
| 37 | +* Run _all_ the tests to assure nothing else was accidentally broken. However travis will do that for you as well. |
| 38 | + |
| 39 | +## Making Trivial Changes |
| 40 | + |
| 41 | +For changes of a trivial nature, it is not always necessary to create a new issue. |
| 42 | + |
| 43 | +## Additional resources |
| 44 | + |
| 45 | +* [Rendered documentation](https://docs.typo3.org/typo3cms/extensions/cart/) |
| 46 | +* [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/) |
| 47 | + |
| 48 | + |
| 49 | +## Contributor Code of Conduct |
| 50 | + |
| 51 | +As contributors and maintainers of this project, and in the interest of fostering an open and |
| 52 | +welcoming community, we pledge to respect all people who contribute through reporting issues, |
| 53 | +posting feature requests, updating documentation, submitting pull requests or patches, and other |
| 54 | +activities. |
| 55 | + |
| 56 | +We are committed to making participation in this project a harassment-free experience for everyone, |
| 57 | +regardless of level of experience, gender, gender identity and expression, sexual orientation, |
| 58 | +disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. |
| 59 | + |
| 60 | +Examples of unacceptable behavior by participants include: |
| 61 | + |
| 62 | +* The use of sexualized language or imagery |
| 63 | +* Personal attacks |
| 64 | +* Trolling or insulting/derogatory comments |
| 65 | +* Public or private harassment |
| 66 | +* Publishing other's private information, such as physical or electronic addresses, without explicit |
| 67 | + permission |
| 68 | +* Other unethical or unprofessional conduct. |
| 69 | + |
| 70 | +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, |
| 71 | +code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By |
| 72 | +adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently |
| 73 | +applying these principles to every aspect of managing this project. Project maintainers who do not |
| 74 | +follow or enforce the Code of Conduct may be permanently removed from the project team. |
| 75 | + |
| 76 | +This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. |
| 77 | + |
| 78 | +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. |
| 79 | + |
| 80 | +This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), |
| 81 | +version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/) |
0 commit comments