From f024da98344e50521dbc5fe5af7e44099f6f940d Mon Sep 17 00:00:00 2001 From: Mahmoud Mabrouk Date: Fri, 22 Sep 2023 10:37:38 +0200 Subject: [PATCH] update contributor to limit inactive prs --- CONTRIBUTING.md | 33 +++++++++++++++++---------- docs/contributing/getting-started.mdx | 31 ++++++++++++++----------- 2 files changed, 39 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee5a56affe..056f6df223 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,34 +1,43 @@ +--- +title: "Contributing to Agenta" +description: "Guidelines for contributing to the Agenta project" +--- -Hello, thank you for your interest in contributing to our project. We value your time and effort and hope to make this process as smooth as possible. +Thanks for your interest in contributing to Agenta! We appreciate your effort and aim to make your contribution experience as straightforward as possible. ## Getting Started -1. **Local Installation:** Before you start contributing, please install the project locally. You can find the necessary steps in our [Local Installation Guide](https://docs.agenta.ai/installation/local-installation/local-installation). +1. **Local Installation:** First, set up the project on your local machine. Follow the steps in our [Local Installation Guide](https://docs.agenta.ai/installation/local-installation/local-installation). -2. **Understanding the Project:** Please take some time to read through our [Conceptual Guide](https://docs.agenta.ai/conceptual/concepts) and [Architecture Guide](https://docs.agenta.ai/conceptual/architecture) to understand the underlying principles and architecture of our project. +2. **Understand the Project:** Familiarize yourself with our architecture and concepts by reading our [Conceptual Guide](https://docs.agenta.ai/conceptual/concepts) and [Architecture Guide](https://docs.agenta.ai/conceptual/architecture). -3. **Start Development** Once you have a local installation and a good understanding of the project, you can start contributing. You can read the following tutorial to learn how to run the code in development mode: [Development Mode Tutorial](https://docs.agenta.ai/contributing/development-mode). +3. **Begin Development:** Once you've installed the project and understand its architecture, you're ready to contribute. See the [Development Mode Tutorial](https://docs.agenta.ai/contributing/development-mode) for instructions on running the code in development mode. ## Code Formatting and Linting -For consistent and clean code, we enforce specific formatting and linting standards: +To maintain code quality, we adhere to certain formatting and linting rules: -- **Backend & CLI Formatting with Black:** We use `black` for code formatting in the directories: +- **Backend & CLI Formatting with Black:** Use `black` for formatting code in the following directories: - `agenta-backend/**` - `agenta-cli/**` - `examples/**` - To format, install `black` using `pip install black`, navigate to the desired directory, and run `black .`. + Install `black` with `pip install black`, navigate to the target directory, and run `black .`. -- **Frontend Formatting with Prettier:** Our frontend adopts `prettier` for formatting. Within the `agenta-web` directory, run `npm run format-fix`. If you haven't installed `prettier`, use `npm install prettier`. +- **Frontend Formatting with Prettier:** We use `prettier` for frontend formatting. Run `npm run format-fix` in the `agenta-web` directory. If you haven't yet installed `prettier`, do so with `npm install prettier`. ## Contribution Steps -1. **Find an issue:** A good starting point for contributing is to find an existing issue and solve it. Browse our issue tracker, find something that suits your skills, and start coding! Please read through our guide to [Creating an issue](file-issue) +1. **Pick an Issue:** Start by selecting an issue from our issue tracker. Choose one that matches your skill set and begin coding. For more on this, read our [Creating an Issue Guide](file-issue). -2. **Fork & Pull Request:** We follow the standard fork & pull request process. Fork our repository, create a new branch, make your changes, and submit a pull request. Make sure your code follows our coding standards and include relevant unit tests. +2. **Fork & Pull Request:** Fork our repository, create a new branch, add your changes, and submit a pull request. Ensure your code aligns with our standards and includes appropriate unit tests. -3. **Build a Larger Feature:** If you're interested in building a larger feature, we would love to hear from you! Reach out directly in Slack or schedule a meeting using this [Calendly link](https://usemotion.com/meet/mahmoud-mabrouk-r0qp/collaborate?d=30). +3. **Contribute a Larger Feature:** If you're interested in developing a more extensive feature, let's discuss! Contact us directly on Slack or schedule a meeting through this [Calendly link](https://usemotion.com/meet/mahmoud-mabrouk-r0qp/collaborate?d=30). +## Contribution Rules -Thank you for your interest in contributing to Agenta. We look forward to your pull requests! +We had many zombie issues and PRs (assigned but inactive) in the past. We want to avoid this in the future, so we've set up the following rules: +- An issue may only be assigned to one person for up to one week (three days for very simple issues). If the issue remains unsolved after a week, it will be unassigned and made available to others. +- Any pull request (PR) left inactive by the author for over a week will be closed. The author can reopen it if they wish to continue. + +We look forward to seeing your contributions to Agenta! \ No newline at end of file diff --git a/docs/contributing/getting-started.mdx b/docs/contributing/getting-started.mdx index 7743419efd..dae8f559d0 100644 --- a/docs/contributing/getting-started.mdx +++ b/docs/contributing/getting-started.mdx @@ -1,38 +1,43 @@ --- title: "Contributing to Agenta" -description: "Some pointers to start contributing in Agenta" +description: "Guidelines for contributing to the Agenta project" --- -Hello, thank you for your interest in contributing to our project. We value your time and effort and hope to make this process as smooth as possible. +Thanks for your interest in contributing to Agenta! We appreciate your effort and aim to make your contribution experience as straightforward as possible. ## Getting Started -1. **Local Installation:** Before you start contributing, please install the project locally. You can find the necessary steps in our [Local Installation Guide](https://docs.agenta.ai/installation/local-installation/local-installation). +1. **Local Installation:** First, set up the project on your local machine. Follow the steps in our [Local Installation Guide](https://docs.agenta.ai/installation/local-installation/local-installation). -2. **Understanding the Project:** Please take some time to read through our [Conceptual Guide](https://docs.agenta.ai/conceptual/concepts) and [Architecture Guide](https://docs.agenta.ai/conceptual/architecture) to understand the underlying principles and architecture of our project. +2. **Understand the Project:** Familiarize yourself with our architecture and concepts by reading our [Conceptual Guide](https://docs.agenta.ai/conceptual/concepts) and [Architecture Guide](https://docs.agenta.ai/conceptual/architecture). -3. **Start Development** Once you have a local installation and a good understanding of the project, you can start contributing. You can read the following tutorial to learn how to run the code in development mode: [Development Mode Tutorial](https://docs.agenta.ai/contributing/development-mode). +3. **Begin Development:** Once you've installed the project and understand its architecture, you're ready to contribute. See the [Development Mode Tutorial](https://docs.agenta.ai/contributing/development-mode) for instructions on running the code in development mode. ## Code Formatting and Linting -For consistent and clean code, we enforce specific formatting and linting standards: +To maintain code quality, we adhere to certain formatting and linting rules: -- **Backend & CLI Formatting with Black:** We use `black` for code formatting in the directories: +- **Backend & CLI Formatting with Black:** Use `black` for formatting code in the following directories: - `agenta-backend/**` - `agenta-cli/**` - `examples/**` - To format, install `black` using `pip install black`, navigate to the desired directory, and run `black .`. + Install `black` with `pip install black`, navigate to the target directory, and run `black .`. -- **Frontend Formatting with Prettier:** Our frontend adopts `prettier` for formatting. Within the `agenta-web` directory, run `npm run format-fix`. If you haven't installed `prettier`, use `npm install prettier`. +- **Frontend Formatting with Prettier:** We use `prettier` for frontend formatting. Run `npm run format-fix` in the `agenta-web` directory. If you haven't yet installed `prettier`, do so with `npm install prettier`. ## Contribution Steps -1. **Find an issue:** A good starting point for contributing is to find an existing issue and solve it. Browse our issue tracker, find something that suits your skills, and start coding! Please read through our guide to [Creating an issue](file-issue) +1. **Pick an Issue:** Start by selecting an issue from our issue tracker. Choose one that matches your skill set and begin coding. For more on this, read our [Creating an Issue Guide](file-issue). -2. **Fork & Pull Request:** We follow the standard fork & pull request process. Fork our repository, create a new branch, make your changes, and submit a pull request. Make sure your code follows our coding standards and include relevant unit tests. +2. **Fork & Pull Request:** Fork our repository, create a new branch, add your changes, and submit a pull request. Ensure your code aligns with our standards and includes appropriate unit tests. -3. **Build a Larger Feature:** If you're interested in building a larger feature, we would love to hear from you! Reach out directly in Slack or schedule a meeting using this [Calendly link](https://usemotion.com/meet/mahmoud-mabrouk-r0qp/collaborate?d=30). +3. **Contribute a Larger Feature:** If you're interested in developing a more extensive feature, let's discuss! Contact us directly on Slack or schedule a meeting through this [Calendly link](https://usemotion.com/meet/mahmoud-mabrouk-r0qp/collaborate?d=30). +## Contribution Rules -Thank you for your interest in contributing to Agenta. We look forward to your pull requests! +We had many zombie issues and PRs (assigned but inactive) in the past. We want to avoid this in the future, so we've set up the following rules: +- An issue may only be assigned to one person for up to one week (three days for very simple issues). If the issue remains unsolved after a week, it will be unassigned and made available to others. +- Any pull request (PR) left inactive by the author for over a week will be closed. The author can reopen it if they wish to continue. + +We look forward to seeing your contributions to Agenta! \ No newline at end of file