Contributing to pRESTd

contributions are welcome to help improve and grow the project

Thank you for your interest in contributing to pREST! Before you get started, please take a moment to review the following guidelines.

Code of Conduct

Please review our Code of Conduct to understand the expected behaviour within the pREST community.

How to Contribute

  1. Fork the repository to your GitHub account.

  2. Clone the forked repository to your local machine:

    git clone<your-username>/prest.git
  3. Create a new branch for your changes:

    git checkout -b feature-branch
  4. Make your changes and commit them:

    git commit -m "Describe of your changes"
  5. Push the changes to your forked repository:

    git push origin feature-branch
  6. Open a pull request on the official pREST repository. Provide a clear title, a description of your changes, and any relevant information.

Development Setup

If you're planning to make significant contributions or work on new features, follow these steps to set up your development environment:

  1. Install Go (if not already installed): Download Go

  2. Install project dependencies:

    go get -u ./...
  3. Run tests to make sure everything is set up correctly:

    go test ./...
  4. Make your changes, update tests if necessary, and ensure that all tests pass before submitting a pull request.

Coding Guidelines

  • Follow the Effective Go guidelines.

  • Adhere to the existing coding style and conventions used in the project.

  • Write clear and concise commit messages.

  • Document your code using comments where necessary.

Reporting Issues

If you encounter any issues or have suggestions for improvement, please open an issue on the GitHub issue tracker.

Feature Requests

If you have a feature you'd like to see added to pREST, open an issue on the GitHub issue tracker and use the "Feature Request" label.

Review Process

Maintainers will review pull requests, and feedback will be provided. Once approved, changes will be merged into the main branch.

Thank you for contributing to pREST! Your help is greatly appreciated.

Last updated