Skip to content

Latest commit

 

History

History
191 lines (129 loc) · 12.5 KB

CONTRIBUTING.md

File metadata and controls

191 lines (129 loc) · 12.5 KB
Raw

Contributing to codeExplainer

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

I have a Question

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.
  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (If you are looking for support, you might want to check this section).
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
  • Collect information about the bug:
    • Stack trace (Traceback)
    • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
    • Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
    • Possibly your input and the output
    • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as needs-repro. Bugs with the needs-repro tag will not be addressed until they are reproduced.
  • If the team is able to reproduce the issue, it will be marked needs-fix, as well as possibly other tags (such as critical), and the issue will be left to be implemented by someone.

Suggesting Enhancements

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

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • 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.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  • You may want to include screenshots and animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this enhancement would be useful to most codeExplainer users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Your First Code Contribution

  1. Fork the project repository by clicking the Fork button in the top right corner of the project page.

  2. Clone the repository to your local machine using git clone https://github.com/[your-user-name]/codeExplainer.git

  3. Create a new branch for your changes using git checkout -b [your-branch-name]. Please follow this syntax for branch naming: feature/issue-[issue number you're assigned to]

  4. Run npm install to install all dependencies.

  5. Navigate to the extension.js file and press F5 to run the extension in debug mode. It'll open a new Extension Development Host window.

  6. Check if the extension is running on your local machine by pressing Ctrl+Shift+P to open the command palette in the Extension Development Host. Type explain and press Enter. If the extension is running, you should see a notification in the bottom right corner of the window.

  7. Make your changes to the code and test them in the VS Code window. You can also use the console.log() function to log messages to the debug console.

Improving The Documentation

Documentation is a critical aspect of our project. Clear and comprehensive documentation helps us maintain the project effectively and ensures that both contributors and users have a smooth experience. Whether you are fixing a bug, adding a feature, or making any other contribution, please consider contributing to our documentation as well. Here's how you can help:

1. Updating Existing Documentation

If you find outdated or inaccurate information in our existing documentation, don't hesitate to make improvements. Follow these steps:

Locate the documentation file or section that needs updates. Make the necessary changes in your branch, ensuring clarity and correctness. Commit your changes with a descriptive commit message that references the documentation issue if applicable. Submit a pull request, and our team will review and merge your changes.

2. Adding New Documentation

If you identify gaps in our documentation or believe that new documentation could benefit the project, we welcome your contributions:

Create a new documentation file or section within the appropriate directory. Write clear, concise, and informative content. Include code examples, if relevant, to illustrate concepts or procedures. Commit your new documentation with an informative commit message. Submit a pull request, explaining the purpose and content of your documentation addition.

3. Reporting Documentation Issues

If you come across issues in our documentation that you're unable to fix yourself, we encourage you to report them:

Open a new issue, clearly describing the problem or inconsistency you've found. Include details such as the location of the issue, any relevant context, and suggestions for improvement if possible. Our team will review your issue and work on resolving it.

4. Documentation Formatting

We follow a consistent formatting style for our documentation to maintain readability and consistency. Here are some guidelines to adhere to:

Use Markdown for documentation files (.md) to ensure compatibility. Use headers, bullet points, and code blocks appropriately for organization and clarity. Include relevant links and references where necessary. Follow our code of conduct when making changes to the documentation, ensuring respectful and inclusive language.

5. Documenting Code Changes

When making significant code changes, ensure that you update any affected documentation to reflect these changes. This includes:

Updating code comments to match the code modifications. Documenting new functions, classes, or methods. Reflecting any changes in configuration settings or usage instructions. Thank you for your contributions to improving our project's documentation. Your efforts help us maintain a robust and user-friendly resource for the community.

  • If you have any questions or need assistance with documentation-related contributions, please feel free to reach out to our maintainers or the community for guidance.

  • We appreciate your dedication to making our project better for everyone. Happy documenting! 📖✍️