google-labs-jules[bot] 518038dc38 feat(docs): Complete documentation audit and add key missing files

This commit addresses several gaps identified in a comprehensive documentation audit.

- Adds `AUDIT-DOCUMENTATION.md` with the full audit report.
- Adds a `CONTRIBUTING.md` to guide new contributors.
- Adds a `CHANGELOG.md` to track version history.
- Adds `docs/faq.md` and `docs/troubleshooting.md` to improve user support.
- Updates `mkdocs.yml` to include the new documentation pages.

Co-authored-by: Snider <631881+Snider@users.noreply.github.com>

2026-02-02 01:18:33 +00:00

2.3 KiB

Raw Blame History

Contributing to Enchantrix

First off, thank you for considering contributing to Enchantrix! It's people like you that make open source such a great community.

Where do I go from here?

If you've noticed a bug or have a feature request, make one! It's generally best if you get confirmation of your bug or approval for your feature request this way before starting to code.

Fork & create a branch

If this is something you think you can fix, then fork Enchantrix and create a branch with a descriptive name.

A good branch name would be (where issue #38 is the ticket you're working on):

git checkout -b 38-add-awesome-new-feature

Getting started

Development Environment

To get started with development, you'll need to have Go 1.25 installed on your system, as specified in the go.mod file. You can download it from the official Go website.

Once you have Go installed, you can clone your fork of the repository:

git clone https://github.com/YOUR_USERNAME/Enchantrix.git
cd Enchantrix

Running Tests

Enchantrix uses the standard Go testing tools. To run all tests, use the following command from the root of the repository:

go test ./...

To run tests with race detection, which is recommended:

go test -race ./...

To generate a coverage report:

go test -coverprofile=coverage.out ./...

Code Style

This project follows standard Go coding conventions. Please ensure your code is formatted with gofmt before submitting a pull request. Most IDEs can be configured to do this automatically on save.

gofmt -w .

Submitting a Pull Request

When you're ready to submit a pull request, please make sure you do the following:

Write tests. Your patch won't be accepted if it doesn't have tests.
Follow the style guide. Your code should be formatted with gofmt.
Write a good commit message. A good commit message should be descriptive and concise.
Push to your fork and submit a pull request.
Ensure the test suite passes. The CI pipeline will run the tests, and your PR will not be merged if the tests are failing.

We'll review your pull request as soon as possible. We may suggest some changes or improvements or approve it as is.

2.3 KiB Raw Blame History