Skip to content

Latest commit

 

History

History
101 lines (66 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

101 lines (66 loc) · 2.74 KB
Raw

Thank you for wanting to contribute to Ossistant! 😃

Table of Contents

Getting Started

To set up the project on your local machine and start contributing, follow the steps outlined below.

Prerequisites

  • Node.js (at least version 18.X.X)
  • npm (at least version 8.X.X)

Installation

  1. Clone the repository to your local machine using Git:
git clone https://github.com/{your-user-name}/AR-Personal-Assistant
  1. Navigate to the project's root directory:
cd AR-Personal-Assistant
  1. Install the required dependencies
yarn install
  1. Start the development server:
yarn run dev

The application should now be running locally at http://localhost:3000.

Contributing

We welcome all contributions to Ossistant. Whether you want to report a bug, submit a feature request, or fix an issue, your help is invaluable. Please follow the guidelines below for a smooth contribution process.

Creating Issues

If you encounter a bug or have an idea for an improvement, please check the existing issues to see if a similar one has already been reported. If not, go ahead and create a new issue with the following details:

  • A clear and descriptive title.
  • A detailed description of the bug or enhancement request.
  • Steps to reproduce the bug, if applicable.
  • The expected behavior.
  • Any relevant screenshots or error messages.
  • Making Changes
  • Create a new branch for your contribution:
git checkout -b your-branch-name

Make your desired changes and ensure you follow the project's code quality and standards.

  • Commit your changes with a meaningful commit message:
git commit -m "Your descriptive commit message"
  • Push your branch to the remote repository:
git push origin your-branch-name

Creating Pull Requests

  1. Navigate to the Ossistant repository on GitHub.

  2. Switch to your recently pushed branch.

  3. Click on the "Pull Request" button and fill in the necessary details, including:

    • A descriptive title.
    • A detailed description of the changes made.
    • Mention any related issues using the appropriate syntax (e.g., "Fixes #123").
    • Submit the pull request.

  4. A project maintainer will review your changes, provide feedback if necessary, and merge the pull request once everything looks good.

Thank you for contributing to Ossistant! Your efforts make this project better for everyone. If you have any questions or need further assistance, feel free to reach out to us. Happy coding!