Skip to content

Contribution Guidelines

Jump to bottom
hadcomfort edited this page Jun 12, 2025 · 1 revision

Contribution Guidelines

Thank you for your interest in contributing to the Veterans Information Resource! Your help is essential for keeping this project accurate, up-to-date, and useful for our nation's veterans.

This project is open to all, and we welcome contributions of any size, from fixing a typo to improving the core logic of the Preference Advisor.

Code of Conduct

All contributors are expected to abide by our Code of Conduct. Please be respectful and constructive in all your interactions.

How to Contribute

The general workflow for contributing is as follows:

  1. Find an Issue: Start by looking at our open issues list. Issues tagged with good first issue are a great place to start. If you have an idea that doesn't have an issue, please create one first to discuss the change.

  2. Fork the Repository: Create a personal fork of the project by clicking the "Fork" button in the top-right corner of the repository page.

  3. Create a Branch: Create a new branch in your fork for your changes. Use a descriptive name, like fix/advisor-broken-link or feat/add-new-faq-section.

    git checkout -b your-branch-name

  4. Make Your Changes: Edit the files to implement your changes. Be sure to follow our Coding and Content Style Guide.

  5. Test Your Changes: Run the site locally to make sure your changes work as expected and don't introduce any new errors. See the Local Development Setup guide for instructions.

  6. Commit Your Changes: Write a clear, concise commit message describing what you've done. For example: docs: Fix typo in VRA guide.

  7. Submit a Pull Request (PR): Push your branch to your fork and open a Pull Request against the main branch of the original repository. The PR template will guide you through providing the necessary information for a review.

Getting Help

If you have questions about a specific issue or need help getting started, please feel free to comment on the relevant issue or start a new thread in the Discussions tab.

Clone this wiki locally