Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (55 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

86 lines (55 loc) · 2.9 KB

Contributing to OSP - Ollama Secure Proxy

We welcome contributions from everyone who is interested in improving OSP and making it more secure and functional. Below you will find guidelines that will help you contribute effectively.

Getting Started

Prerequisites

Before you can contribute, you'll need the following:

  • Familiarity with Git and GitHub workflows
  • Node.js and npm installed on your machine
  • Basic knowledge of JavaScript and Express.js

Setting Up for Development

  1. Fork the Repository: Start by forking the OSP repository to your GitHub account. This creates your own copy of the project where you can make changes.

  2. Clone Your Fork: Clone your forked repository to your local machine to start making changes.

    git clone https://github.com/dheavy/ollama-secure-proxy.git
cd ollama-secure-proxy

  3. Install Dependencies: Navigate to the project directory and install the necessary dependencies.

    npm install

  4. Create a Branch: Create a new branch on which you will make your changes.

    git checkout -b your-new-feature

Making Changes

Coding Guidelines

  • Code Style: Follow the coding style used in the project. Use linters and format your code before submitting.
  • Testing: Add tests for any new features or fixes. Ensure all tests pass before submitting a pull request.
  • Documentation: Update documentation to reflect changes or add new sections as needed.

Committing Your Changes

  • Write clear and concise commit messages, describing what has been changed and why.
  • Include any related issue numbers in your commit messages.

Submitting a Pull Request

  1. Push Your Changes: Push your branch to your fork on GitHub.

    git push origin your-new-feature

  2. Open a Pull Request: From your repository on GitHub, you'll see a "Compare & pull request" button. Click it and describe the changes you've made.

  3. Review Process: Once submitted, the maintainers will review your pull request. Be open to making revisions based on feedback.

Community and Conduct

  • Be Respectful: Treat everyone with respect. Participate while acknowledging that everyone deserves a courteous environment.
  • Inclusive Language: Use inclusive language and be mindful of addressing the community members.

Issue Tracking

  • Reporting Issues: Before creating a new issue, ensure it does not already exist. Clearly describe the issue, including steps to reproduce when possible.
  • Enhancement Suggestions: For feature requests, clearly describe expected benefits and possible implementations.

Help and Support

If you encounter issues or need assistance, don't hesitate to ask questions on the GitHub issues page or seek help from community forums.

License

By contributing to OSP, you agree that your contributions will be licensed under its MIT License.