Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
101 lines (67 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

101 lines (67 loc) · 1.8 KB
Raw

Contributing

Thanks for contributing to Avnac. Pull requests are welcome.

Important: For major changes, open an issue first so the idea can be discussed before work starts.

Before You Start

  1. Search the open PRs to make sure a pull request doesn't already exist for that issue.
  2. If you want to open a new issue, check that it has not already been raised.
  3. For larger changes, comment on the issue before starting so the work stays aligned with the project direction.

Getting Started

  1. Fork the repository and clone your fork.
git clone https://github.com/YOUR_USERNAME/avnac.git
cd avnac
  1. Install dependencies.
cd frontend
npm install

If you want to work on the backend:

cd backend
npm install

If you install both packages, you can also run the shared repo-level quality commands from the project root:

npm run lint
npm run format:check

Run Locally

Frontend:

cd frontend
npm run dev

Backend:

cd backend
npm run dev

Make Changes

  1. Create a branch for your work.
git checkout -b fix/short-description

  1. Make your changes.

  2. Run the relevant checks before you commit.

npm run lint
npm run format:check

If you only changed one side of the app, you can run the same commands inside frontend/ or backend/.

Commit and Pull Request

  1. Commit your fix with a clear message, ideally using a semantic prefix such as fix: or feat:.
git commit -m "fix: describe the change"
  1. Push your branch.
git push origin your-branch-name
  1. Open a pull request against main and include:
  • What changed
  • The issue number

Notes

  • Keep pull requests focused on a single change.
  • If the change affects behavior or UI, add screenshots.
  • Thank you for helping improve Avnac.