Skip to content

Latest commit

 

History

History
106 lines (68 loc) · 4.52 KB

CONTRIBUTING.md

File metadata and controls

106 lines (68 loc) · 4.52 KB

Contribution Guidelines

Welcome to our agricultural products project! We appreciate your interest in contributing. Whether you're a developer, designer, researcher, or simply want to help in any way, we value your contributions.

Before you get started, please take a moment to read through these contribution guidelines to ensure a smooth and collaborative experience.

Table of Contents

How to Contribute

Here are some ways you can contribute to our project:

  • Reporting issues and bugs
  • Suggesting new features or improvements
  • Writing code (features, bug fixes, or documentation)
  • Reviewing and testing pull requests
  • Helping with documentation improvements
  • Providing feedback and ideas

Getting Started

If you're new to our project, we recommend the following steps to get started:

  1. Clone the repository: Use git clone to create a local copy of the main repository.

  2. Choose your focus: Our project consists of two major parts:

    • Official Website: If you want to work on the official website frontend, navigate to the website directory.
    • User Dashboard: If you're interested in the user dashboard frontend, navigate to the dashboard directory.

  3. Set up a development environment: Refer to the Development Setup section below for instructions on setting up your development environment based on your chosen focus.

  4. Make changes: Work on your changes, whether it's fixing a bug, adding a feature, or improving documentation.

  5. Test your changes: Ensure your changes work as expected. Refer to the Testing section for guidance.

  6. Create a pull request: When you're ready, submit a pull request to the main repository's main branch, specifying whether your changes are related to the website or the dashboard.

Code of Conduct

Please note that we have a Code of Conduct that we expect all contributors to adhere to. By participating in our project, you agree to abide by its terms.

Reporting Issues

If you encounter a bug or have a problem with the project, please report it by opening an issue on our Issue Tracker.

Feature Requests

If you have an idea for a new feature or an improvement to an existing one, please open an issue on our Issue Tracker and label it accordingly based on whether it's related to the website or the dashboard.

Pull Requests

We welcome contributions in the form of pull requests. Please follow these guidelines when creating pull requests:

  • Ensure your code is well-documented and follows our coding style.
  • Provide a clear and concise description of your changes in the pull request.
  • Reference any related issues in your pull request.
  • Be prepared to address feedback and make necessary changes during the review process.

Development Setup

To set up a development environment for your chosen focus, follow these steps:

Official Website (Website Directory)

  1. [Installation instructions and prerequisites for the website]
  2. [Configuration steps specific to the website]
  3. [Running the website locally]

User Dashboard (Dashboard Directory)

  1. [Installation instructions and prerequisites for the dashboard]
  2. [Configuration steps specific to the dashboard]
  3. [Running the dashboard locally]

Testing

We have a suite of tests that should be run before submitting a pull request. To run the tests, follow these steps:

  1. [Instructions for running tests]

Documentation

We value clear and comprehensive documentation. If you make changes to the project, please update the documentation accordingly.

Contact

If you have questions or need assistance, you can reach out to us at [your contact email or communication channel].

Thank you for contributing to our agricultural products project! Your efforts are greatly appreciated.

[AgricHub Project Team]