From 539d109487a40cf66dc290a22192c74290472475 Mon Sep 17 00:00:00 2001 From: Jan Guth Date: Mon, 25 Mar 2024 14:10:58 +0100 Subject: [PATCH] relax contribution req --- CONTRIBUTING.md | 12 ++---------- www/apps/docs/content/contribution/argsh.md | 2 +- www/apps/docs/content/contribution/docs.md | 6 +----- 3 files changed, 4 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06704b1..7d79458 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,20 +19,12 @@ If you, as a community contributor, wish to work on more extensive features, ple 1. Before you start working on a change please make sure that there is an issue for what you will be working on. You can either find and [existing issue](https://github.com/arg-sh/argsh/issues) or [open a new issue](https://github.com/arg-sh/argsh/issues/new) if none exists. Doing this makes sure that others can contribute with thoughts or suggest alternatives, ultimately making sure that we only add changes that make -2. When you are ready to start working on a change you should first [fork the argsh repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) and [branch out](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository) from the `develop` branch. +2. When you are ready to start working on a change you should first [fork the argsh repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) and [branch out](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository) from the `main` branch. 3. Make your changes. 4. [Open a pull request towards the develop branch in the argsh repo](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). Within a couple of days a argsh team member will review, comment and eventually approve your PR. ## Workflow -### Branches - -All changes should be part of a branch and submitted as a pull request - your branches should be prefixed with one of: - -- `fix/` for bug fixes -- `feat/` for features -- `docs/` for documentation changes - ### Commits Strive towards keeping your commits small and isolated - this helps the reviewer understand what is going on and makes it easier to process your requests. @@ -41,7 +33,7 @@ Strive towards keeping your commits small and isolated - this helps the reviewer If your changes should result in a new version of argsh, you will need to generate a **changelog**. Follow [this guide](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) on how to generate a changeset. -Finally, submit your branch as a pull request. Your pull request should be opened against the `develop` branch in the main argsh repo. +Finally, submit your branch as a pull request. Your pull request should be opened against the `main` branch in the main argsh repo. In your PR's description you should follow the structure: diff --git a/www/apps/docs/content/contribution/argsh.md b/www/apps/docs/content/contribution/argsh.md index c13af7f..16af9fe 100644 --- a/www/apps/docs/content/contribution/argsh.md +++ b/www/apps/docs/content/contribution/argsh.md @@ -23,7 +23,7 @@ If you’re adding a new library or contributing to the codebase, you need to fo When you make an edit to an existing documentation page or fork the repository to make changes to the documentation, you have to create a new branch. -Documentation contributions always use `develop` as the base branch. Make sure to also open your PR against the `develop` branch. +Documentation contributions always use `main` as the base branch. Make sure to also open your PR against the `main` branch. ### Branch Name diff --git a/www/apps/docs/content/contribution/docs.md b/www/apps/docs/content/contribution/docs.md index 4e8c7c7..90c4097 100644 --- a/www/apps/docs/content/contribution/docs.md +++ b/www/apps/docs/content/contribution/docs.md @@ -53,11 +53,7 @@ If you’re adding a new page or contributing to the codebase, you need to fork When you make an edit to an existing documentation page or fork the repository to make changes to the documentation, you have to create a new branch. -Documentation contributions always use `develop` as the base branch. Make sure to also open your PR against the `develop` branch. - -### Branch Name - -Make sure that the branch name starts with `docs/`. For example, `docs/fix-services`. Vercel deployed previews are only triggered for branches starting with `docs/`. +Documentation contributions always use `main` as the base branch. Make sure to also open your PR against the `main` branch. ### Pull Request Conventions