Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (41 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

63 lines (41 loc) · 2.63 KB

Contributing to VS Code Aster

Thank you for your interest in contributing to VS Code Aster, a project developed by Simvia SAS ! We welcome contributions from everyone, whether it's reporting bugs, suggesting features, improving documentation, or submitting code.

Please take a moment to review this document to understand how you can contribute effectively.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it to ensure a positive and inclusive environment for everyone.

How Can I Contribute?

Reporting Bugs

  • Check existing issues: Before opening a new issue, search the issue tracker to avoid duplicates.
  • Open a new issue: If the bug hasn't been reported, create a new issue with a clear title and description. Include:
    • Steps to reproduce the issue.
    • Expected and actual behavior.
    • Screenshots or logs, if applicable.
    • Your environment (OS, VS Code version or fork, extension version, etc).

Suggesting Features

  • Open an issue with the label enhancement.
  • Describe the feature, its use case, and why it would be beneficial.
  • Include mockups, examples, or references if possible.

Improving Documentation

  • Fix typos, clarify instructions, or add missing details.
  • Open a pull request (PR) with your changes.

Submitting Code

  1. Fork the repository and create a new branch from main.
  2. Follow the project's coding style (naming conventions follow the standard of each language, formatting is made using Prettier for JS/TS/HTML and Black for Python).
  3. Write tests for new features or bug fixes.
  4. Commit your changes with a descriptive message (e.g., fix: correct login validation).
  5. Open a pull request to the main branch. Include:
    • A clear title and description of the changes.
    • Reference any related issues (e.g., fixes #123).
    • Screenshots or logs for UI changes.

Development setup

Please refer to the README to setup your development environment.

Pull Request Guidelines

Ensure your code passes all tests. Keep PRs focused and concise. Large changes should be broken into smaller PRs. Update the Changelog if your changes affect functionality. A maintainer will review your PR and may request changes.

Recognition

All contributors will be acknowledged in the project's README file.

Contact

For questions or feedback, reach out to us:

Email: ulysse.bouchet@simvia.tech or basile.marchand@simvia.tech.