How to Contribute
Open source projects thrive on contributions from the developer community. Would like to get involved? There is plenty that you can do to help!
This is a general guide about how to contribute to Glimpse. It is not a set of hard and fast rules. Any questions, concerns or suggestions should be raised on the Glimpse Developers List.
Bugs should be reported in the GitHub Issue tracker if they have not been previously submitted.
When reporting a bug or issue, please include all pertinent information. This typically includes:
- Glimpse package(s) installed (Example: Glimpse.Mvc22.214.171.124 and FluentSecurity.Glimpse.1.1)
- Development platform, including .NET version and web server (Example: Mvc3 with .NET version 4.0 on IIS Express)
- If the problem is UI related include the browser and its version (Example: IE9)
- Steps to reproduce the bug/example code
- Any error messages and stack trace
It is also quite helpful to include the relevant portions of Glimpse’s log file. You can enable Glimpse logging by adding the
loggingEnabled attribute in web.config.
<glimpse defaultRuntimePolicy="On"> <logging level="Trace" /> </glimpse>
Bugs will be addressed as soon as humanly possible, but please allow ample time. For quicker responses, you may also choose to implement and contribute the bug fix.
Glimpse maintains several issues that are good for first-timers tagged as Jump In on GitHub. If one peaks your interest, feel free to work on it and let us know if you need any help doing so.
For those looking to get more deeply involved, reach out to find out about our current efforts and how you can help. Medium or large contribution should begin by sending a message to the Glimpse Developers List or should start as a basic pull request so that a discussion can be started.
The message should describe the contribution you are interested in making, and any initial thoughts on implementation. This will allow the community to discuss and become involved with you from the get go. If you receive positive feedback on the mailing list, go ahead and start implementation! You should also sign and return the Contributor License agreement, which is required for the Glimpse team to accept your contribution.
The Glimpse team uses the issue tracking features of GitHub which is a good place to look through if you want to get involved but aren't quite sure how.
If you love Glimpse, tell others about it! Present Glimpse at a company tech talk, your local user group or submit a proposal to a conference about how you are using Glimpse or any extensions you may have written.
Create an Extension
Get the best out of Glimpse by writing your own extension to expose diagnostic data that is meaningful for your applications. Creating extensions is easy, check the docs or reference an open source extension to get started.
Documentation is a key differentiator between good projects and great ones. Whether you’re a first time OSS contributor or a veteran, documentation is a great stepping stone to learn our contribution process.
Contributing to Glimpse documentation is dead simple. To make it so easy, we're using Glimpse’s GitHub Wiki as the entry point for documentation - each page within the docs section of the site has a link to take you straight to the page where you can make changes directly. GitHub Wikis provide an online WYSIWYG interface for adding and editing the docs, completely in browser, using Markdown.
Glimpse follows a loose set of coding conventions. Chiefly among them:
- Ensure all unit tests pass successfully
- Cover additional code with passing unit tests
- Try not to add any additional StyleCop warnings to the compilation process
- Ensure your Git autocrlf setting is true to avoid "whole file" diffs.