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

Latest commit

 

History

History
76 lines (44 loc) · 3.78 KB

CONTRIBUTING.md

File metadata and controls

76 lines (44 loc) · 3.78 KB
Raw

Contributing guidelines

There are many different ways in which you can contribute. One of them is simply by using our software and providing us with your feedback or you can actively participate by coding some new features.

This guide describes general guidelines that most of the repositories refer to. We don't want to make things complicated so we try to follow the same rules in every repository. But sometimes there are some rules specific for that particular repository. Always check the contributing guideline and readme in that repository as well.

I have an idea for a new feature

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

It's always a good idea to discuss the feature before you start the implementation. You can check with us whether the feature fits the vision of a given project. We may also give you some useful hints before you start coding. To start chatting, either create a new GitHub issue or contact us via the repository's default communication channel.

I found a bug

Sorry to hear that. Just create new GitHub issue and someone will take a look at that. Please, don't forget to provide us with all the important information like

  • Steps to reproduce the issue
  • Environment and software version used
  • Screenshot
  • Error message
  • What is the expected behavior

The more information you provide, the easier would it be to fix the issue. You can also fix the bug on your own and submit a new pull request.

Submitting pull requests

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.

Example - process of contribution

  1. Tom forks this repository
  2. Creates a new branch for his cool feature
  3. Hacks his code
  4. Writes some tests
  5. Once he's happy with the changes, he submits a pull request from his cool branch to master branch
  6. We discuss the pull request with Tom and maybe suggest some adjustments
  7. Once the code is ready, someone from maintainers will merge it into the master branch

Definition of Done

  • Code requirements:
  • Code is buildable
  • All tests are green
  • Code design follows the .NET Framework Design Guidelines
    • If you're not sure about some rules, follow the style of the existing code.
    • Use "Format the whole document" button in Visual Studio to fix indentation format
  • Documentation is updated

Learn how to write good commit messages

We hate sloppy commit messages. No more Performance tuning or Changed a few files. Please read the following articles to understand what a good commit message is.

Code of Conduct

The Kentico team is committed to fostering a welcoming community.

Our Code of Conduct can be found here:

https://github.com/Kentico/Home/blob/master/CODE_OF_CONDUCT.md

For a history of updates, see the page history here:

https://github.com/Kentico/Home/commits/master/CODE_OF_CONDUCT.md

Analytics