Skip to content

Contribute

Jump to bottom
Gluckez edited this page Mar 4, 2023 · 3 revisions

MonoDevelop is always looking for contributors to help with development. If you have some time and want to help, there are instructions below.

Reporting Bugs

Filing bugs is a very easy way to help contribute to any project. See the Reporting Bugs guide for more info.

Submitting Patches

Patches have to be submitted by using the Pull Request mechanism that github provides. Here is a summary of how it works:

  1. If you don't already have one, you have to create your own fork of the MonoDevelop repository. You can do it using the Fork command available in the main page of the project in github.
  2. Make and commit your changes in your forked repository.
  3. In the main page of your forked repository, click on the Pull Request command.
  4. In the Pull Request dialog, enter a descriptive comment of the change.

Commit Rules

There are a few rules to follow when committing code:

  1. Enter a meaningful explanation in the commit log message.

  2. The first line of the commit message should be a short (ideally <50 columns) message, followed by a blank line. The rest of the commit message could contain a more detailed explanation of the change, wrapped to 80 columns.

  3. When entering a message describing a change, take into account that the goal is to explain why the change was done, rather than what was changed. For example, the message "Added property X" is in general useless since it is obvious looking at the patch.

  4. All changes included in a commit should be related and as atomic as possible. Here are some examples:

    • You do an API change that affects several projects across the source tree. All changes can go in a single commit.
    • You implement a new feature A, for example, in MonoDevelop.Projects. Then you implement another new feature B that uses A in MonoDevelop.Ide. Although those changes are related (B needs A), they should be committed separately, since they belong to two different features.

  5. Don't do reformatting commits, unless you're the original author of the code. This includes changing line endings.

  6. Never remove copyright notices from the code.

  7. Never remove licensing info from code.

  8. Never commit code you didn't write yourself or code that doesn't have a suitable license.

Coding Guidelines

New code written for MonoDevelop should follow the generic Mono Coding Guidelines, with the following exceptions:

  • use camelCase for field names
  • code must be indented using tabs, not spaces, and tabs have a width equal to 4 spaces
  • the opening brace { of a class or namespace should be put on a new line, like methods
  • lines should be wrapped to 120 chars, not 80

The MonoDevelop solution is configured with formatting policies that conform to these guidelines.

Public/protected API should be documented using XML doc comments, but keep them concise and useful. If they're generic/obvious and don't add any value, for example a constructor with a summary "create a new instance of Foo", they should be omitted.

It's recommended to follow the .NET Framework Design Guidelines. If you do not have the excellent and detailed book, there is also a free digest and a section on MSDN. There are also some docs for .NET 1.1 that mostly remain applicable to newer versions of the framework.

A Note on Licensing

All new code and modifications to existing code should be licensed under MIT X11. The MS-PL and Apache 2 licenses are acceptable for new libraries and new addins.

Code and libraries licensed under version 2 of the LGPL license are acceptable under extraordinary circumstances.

Code licensed under the GPL cannot be accepted.

Although addins that do not follow these rules cannot be accepted into the MonoDevelop source repository, they can be hosted elsewhere. However, this generally means that they are much less likely to be maintained and distributed.

Discussions

Discussions on general improvements to dotdevelop are currently here: Discussions

The goal of these discussions it to work out a roadmap for future development, and to give new contributors an idea of what we are working towards. We will update this wiki to include a roadmap soon when it is done and we begin development.

Clone this wiki locally