Skip to content
This repository was archived by the owner on Sep 13, 2024. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (29 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

51 lines (29 loc) · 3.49 KB
Raw

Ways to contribute

There are many different ways in which you can contribute. One of the easiest ways is simply to use our software and provide us with your feedback through the github issue tracker.

You can also help us improve the project by sending a pull request with code and documentation changes.

Where to get support / I found a bug

Please submit issues on the github issue tracker. Alternatively, if you have a fix yourself, please send a pull request.

I need help with using the projects and/or coding

Please review the README. If you still need help, try the Kentico Development slack channel.

I have an idea for a new feature (or feedback on existing functionality)

Everybody loves new features! You can submit a new feature request or you can code it on your own and send a pull request. In either case, don't forget to mention what's the use case and what's the expected output.

Submitting pull requests

Unless you're fixing a typo, it's usually a good idea to discuss the feature before you submit a pull request with code changes, so let's start with submitting a new GitHub issue and discussing the whether it fits the vision of a given project.

You might also read these two blogs posts on contributing code: Open Source Contribution Etiquette by Miguel de Icaza and Don't "Push" Your Pull Requests by Ilya Grigorik. Note that all code submissions will be rigorously reviewed and tested, and only those that meet a high bar for quality and design/roadmap appropriateness will be merged into the source.

Example - process of contribution

If not stated otherwise, we use feature branch workflow.

To start with coding, fork the repository you want to contribute to, create a new branch, and start coding. Once the functionality is done, you can submit a pull request.

Definition of Done

  • New/fixed code is covered with tests
  • CI can build the code
  • All tests are pass
  • New version number follows semantic versioning
  • Coding style (spaces, indentation) is in line with the rest of the code in a given repository
  • Documentation is updated (e.g. code examples in README, Wiki pages, etc.)
  • All public members are documented (using XML doc, phpdoc, etc.)
  • Code doesn't contain any secrets (private keys, etc.)
  • Commit messages are clear. Please read these articles: Writing good commit messages, A Note About Git Commit Messages, On commit messages

Feedback

Your pull request will now go through extensive checks by the subject matter experts on our team. Please be patient. Update your pull request according to feedback until it is approved by one of the Kentico maintainers. After that, one of our team members may adjust the branch you merge into based on the expected release schedule.

Conduct

All contributors are expected to adhere to Kentico's Code of conduct