First of all, Thanks for taking the time to contribute!!
The following is a set of guidelines for contributing to the LSP implementation for OpenFOAM dictionaries and related packages. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
An implementation of a language server protocol will run inside a text editor, hence we strive to use only technology that "just works" on key presses and is fast enough for users to not feel any lag-ish behavior.
However, efficiency is not everything, as we need to support multiple platforms and environments. While we're improving the performance of our code, it's best to stay clear of all techniques which would lead to a platform, or a specific text editor, being left behind.
This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports quickly.
Before creating bug reports, please check:
- You're using the latest version of the LSP and related packages.
- Check the discussions for a list of common questions and problems.
- Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Bugs are tracked as GitHub issues. If you decide that submitting a bug report is necessary, create an issue on this repository and provide the following information by filling in the template.
Non-programs are most welcome to contribute by documenting new OpenFOAM keywords, code snippets and even signature helps.
All you need to do is to follow the examples provided at the Markdown docs and the PlainText docs and add your own to both files.
Then you can issue a pull request with a documentation flag.
Note that documentation for signature help is present only as Plain Text
Please follow these steps to have your contribution considered by the maintainers:
- Only request pulls to the
developbranch - Follow all instructions in the template
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
- What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
- Please keep git history linear at all times. Specifically, you're not allowed to force-push to the master branch.
- All PRs are to be opened against the
developbranch. - Limit the first line in a commit message to 72 characters or less
- Reference issues and pull requests liberally after the first line
This section is not yet complete.