Skip to content

Latest commit

 

History

History
143 lines (108 loc) · 11.5 KB

CONTRIBUTING.md

File metadata and controls

143 lines (108 loc) · 11.5 KB
Raw

Contributing to JCOReflector

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to JCOReflector, which are hosted in the MASES Group Organization on GitHub. Feel free to propose changes to this document in a pull request. We are trying to have a common idea between all partecipant.

Code of Conduct

This project and everyone participating in it is governed by the JCOReflector Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to coc_reporting@masesgroup.com.

Project organization

The project is organized in this folder structure:

  • bin (The output folder, automatically generated and not in git)

    • net462 (folder for .NET Framework output)
    • net6.0 (folder for .NET 6 output)
    • net8.0 (folder for .NET 8 output)

  • netreflected (container of Java classes)

    • src (a standard folder used in any Java IDE)
      • JCOReflector (contains the base classes used from JCOReflector to build reflected classes)
      • net462 (contains, sepearated in folders, the sets of reflected classes of .NET Framework generated from JCOReflector: no manual action shall be made on this folder and subfolders, an issue or enhancement shall be made in the JCOReflector engine (code or templates))
      • net6.0 (contains, sepearated in folders, the sets of reflected classes of .NET 6 generated from JCOReflector: no manual action shall be made on this folder and subfolders, an issue or enhancement shall be made in the JCOReflector engine (code or templates))
      • net8.0 (contains, sepearated in folders, the sets of reflected classes of .NET 8 generated from JCOReflector: no manual action shall be made on this folder and subfolders, an issue or enhancement shall be made in the JCOReflector engine (code or templates))
    • docs
      • net462 (contains the generated documentation related to .NET Framework: no manual action shall be made on this folder and subfolders, an issue or enhancement shall be made in the JCOReflector engine (code or templates))
      • net6.0 (contains the generated documentation related to .NET 6: no manual action shall be made on this folder and subfolders, an issue or enhancement shall be made in the JCOReflector engine (code or templates))
      • net8.0 (contains the generated documentation related to .NET 8: no manual action shall be made on this folder and subfolders, an issue or enhancement shall be made in the JCOReflector engine (code or templates))
    • statistics
      • net462 (contains the generated statistics related to .NET Framework: no manual action shall be made on this folder and subfolders, an issue or enhancement shall be made in the JCOReflector engine (code or templates))
      • net6.0 (contains the generated statistics related to .NET 6: no manual action shall be made on this folder and subfolders, an issue or enhancement shall be made in the JCOReflector engine (code or templates))
      • net8.0 (contains the generated statistics related to .NET 8: no manual action shall be made on this folder and subfolders, an issue or enhancement shall be made in the JCOReflector engine (code or templates))

  • netreflected-tests (container test classes)

    • java (container of Java test classes)
      • src (a standard folder used in any Java IDE)
        • mscorlib (contains an example class which use mscorlib API)
        • nettest (contains an example class which use network API)
        • hierarchy (contains an example class which use hierarchy)
        • refout (contains an example class which use refout)
    • kotlin (container of Java test classes)
      • src (a standard folder used in any Java IDE)
        • main
          • kotlin
            • mscorlib (contains an example class which use mscorlib API)
            • nettest (contains an example class which use network API)
            • hierarchy (contains an example class which use hierarchy)
            • refout (contains an example class which use refout)
    • scala (container of Java test classes)
      • src (a standard folder used in any Java IDE)
        • main
          • scala
            • mscorlib (contains an example class which use mscorlib API)
            • nettest (contains an example class which use network API)
            • hierarchy (contains an example class which use hierarchy)
            • refout (contains an example class which use refout)

  • src (The folder containing the source of the reflection engine)

    • Common (common data)
    • CLI (command line interface)
    • GUI (graphical interface)
    • engine (common reflection engine)

How Can I Contribute?

Work on the project

An user who wants to help us can do what is described in the following chapters.

Development improvements

If you are a developer and want to contribute you are welcome, we reccomend to take into account few rules.

The basic and simple rules for the project are:

  • Reflection engine only commit with modifications in the following folders are accepted:
    • src
    • netreflected/src/JCOReflector
  • Unit test: contibution can be made in the testing code section under netreflected-tests folder
  • Reflected classes: the following folders and subsolders are generated code from JCOReflector, to change them a developer shall modify the templates; the code will be updated from mantairners after the validation of JCOReflector engine:
    • netreflected/src/net6.0
    • netreflected/src/net8.0
    • netreflected/src/net462

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for JCOReflector, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue on that repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of JCOReflector which the suggestion is related to.
  • Explain why this enhancement would be useful to most JCOReflector users.
  • Specify which version of JCOReflector you're using.
  • Specify the name and version of the OS you're using.

Reporting Bugs

This section guides you through submitting a bug report for JCOReflector. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue on that repository and provide the following information by filling in the template.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started JCOReflector, e.g. which command exactly you used in the terminal, or how you started JCOReflector otherwise. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an JCOReflector command, and if so which one?
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. If you use the keyboard while following the steps, record the GIF with the Keybinding Resolver shown.
  • If you're reporting that JCOReflector crashed, include a crash report with a stack trace from the operating system. On macOS, the crash report will be available in Console.app under "Diagnostic and usage information" > "User diagnostic reports". Include the crash report in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.
  • If the problem is related to performance or memory, include a CPU profile capture with your report.
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Provide more context by answering these questions:

  • Can you reproduce the problem in safe mode?
  • Did the problem start happening recently (e.g. after updating to a new version of JCOReflector) or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of JCOReflector? What's the most recent version in which the problem doesn't happen? You can download older versions of JCOReflector from the releases page.
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
  • If the problem is related to working with files (e.g. opening and editing files), does the problem happen for all files and projects or only some? Does the problem happen only when working with local or remote files (e.g. on network drives), with files of a specific type (e.g. only JavaScript or Python files), with large files or files with very long lines, or with files in a specific encoding? Is there anything else special about the files you are using?

Include details about your configuration and environment:

  • Which version of JCOReflector are you using?
  • What's the name and version of the OS you're using?
  • Are you running JCOReflector in a virtual machine? If so, which VM software are you using and which operating systems and versions are used for the host and the guest?
  • Are you using JCOReflector with multiple monitors? If so, can you reproduce the problem when you use a single monitor?
  • Which keyboard layout are you using? Are you using a US layout or some other layout?