Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Pablo Borowicz committed Jan 17, 2020
1 parent b793525 commit 1f9e8ff
Showing 1 changed file with 11 additions and 24 deletions.
35 changes: 11 additions & 24 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,21 @@

Enables you to enter the intra-community VAT number when creating the address. You must fill in the company field to allow entering the VAT number.

## Contributing

PrestaShop modules are open-source extensions to the PrestaShop e-commerce solution. Everyone is welcome and even encouraged to contribute with their own improvements.

### Requirements
## Reporting issues

Contributors **must** follow the following rules:
You can report issues with this module in the main PrestaShop repository. [Click here to report an issue][report-issue].

* **Make your Pull Request on the "dev" branch**, NOT the "master" branch.
* Do not update the module's version number.
* Follow [the coding standards][1].

### Process in details
## Contributing

Contributors wishing to edit a module's files should follow the following process:
PrestaShop modules are open source extensions to the [PrestaShop e-commerce platform][prestashop]. Everyone is welcome and even encouraged to contribute with their own improvements!

1. Create your GitHub account, if you do not have one already.
2. Fork the vatnumber project to your GitHub account.
3. Clone your fork to your local machine in the ```/modules``` directory of your PrestaShop installation.
4. Create a branch in your local clone of the module for your changes.
5. Change the files in your branch. Be sure to follow [the coding standards][1]!
6. Push your changed branch to your fork in your GitHub account.
7. Create a pull request for your changes **on the _'dev'_ branch** of the module's project. Be sure to follow [the commit message norm][2] in your pull request. If you need help to make a pull request, read the [Github help page about creating pull requests][3].
8. Wait for one of the core developers either to include your change in the codebase, or to comment on possible improvements you should make to your code.
Just make sure to follow our [contribution guidelines][contribution-guidelines].

That's it: you have contributed to this open-source project! Congratulations!
## License

[1]: http://doc.prestashop.com/display/PS16/Coding+Standards
[2]: http://doc.prestashop.com/display/PS16/How+to+write+a+commit+message
[3]: https://help.github.com/articles/using-pull-requests
This module is released under the [Academic Free License 3.0][AFL-3.0]

[report-issue]: https://github.com/PrestaShop/PrestaShop/issues/new/choose
[prestashop]: https://www.prestashop.com/
[contribution-guidelines]: https://devdocs.prestashop.com/1.7/contribute/contribution-guidelines/project-modules/
[AFL-3.0]: https://opensource.org/licenses/AFL-3.0

0 comments on commit 1f9e8ff

Please sign in to comment.