Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://visual-replace.readthedocs.io/en/latest/contrib.html below:

Website Navigation

• visual-replace

Contributing — visual-replace 1.2.1snapshot documentation

The most useful thing you can do to help is and useful bug reports to the Issue Tracker

In your report, please discuss what you wanted to happen as well as what happened. Also, please include enough information to reproduce the issue.

Please include:

• the version of Emacs you’re running, taken, for example, from M-x about-emacs

• whether you’re running Emacs in a window environment or a terminal

• the OS you’re running

• the replacement mode - a copy of what’s shown in the minibuffer.

• the text you wanted to replace, the replacement text, the replacement modes - copying the content of minibuffer will do the trick.

Tip

It’s a great idea to take a screenshot of the Emacs window in Visual Replace mode just before executing it, and then another one after executing it and attach that to the issue.

Please create a new discussion or in the Ideas category or add a feature suggestions to the Issue Tracker.

Please create a new discussion in the General category with your question.

To contribute code to the project, open a Pull Request.

Before you do that, please make sure the any new features is covered by tests and that the tests pass.

To run the tests, install and setup eldev, then run eldev test.

Tests can also be run from inside of Emacs, using M-x ert-run-tests-interactively but when you do so, be aware that there might be unexpected interaction with your Emacs configurations. The tests passing reliably when run using eldev test is what matters.

Please also make sure your commit message follows Conventional Commits 1.0.0, in short, the commit message of new features should start with “feat: “, fixes with “fix: “, refactorings with “refactor: ” and tests with “test: “.

You don’t need to be a developer to contribute! Contribution to the documentation or code comments are very welcome. Please open a Pull Request with your proposed modifications. To follow Conventional Commits 1.0.0, the commit message should start with “docs: “

The documentation is written in reStructuredText. You’ll need to install Sphinx to build it:

python3 -m venv venv
. venv/bin/activate # or activate.fish on fish
pip3 install -r docs/requirements.txt

Then run eldev html to build the documentation.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4