Skip to content

Commit 539d109

Browse files
committed
relax contribution req
1 parent ee38586 commit 539d109

3 files changed

Lines changed: 4 additions & 16 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,12 @@ If you, as a community contributor, wish to work on more extensive features, ple
1919

2020
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
2121

22-
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.
22+
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.
2323
3. Make your changes.
2424
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.
2525

2626
## Workflow
2727

28-
### Branches
29-
30-
All changes should be part of a branch and submitted as a pull request - your branches should be prefixed with one of:
31-
32-
- `fix/` for bug fixes
33-
- `feat/` for features
34-
- `docs/` for documentation changes
35-
3628
### Commits
3729

3830
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
4133

4234
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.
4335

44-
Finally, submit your branch as a pull request. Your pull request should be opened against the `develop` branch in the main argsh repo.
36+
Finally, submit your branch as a pull request. Your pull request should be opened against the `main` branch in the main argsh repo.
4537

4638
In your PR's description you should follow the structure:
4739

www/apps/docs/content/contribution/argsh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ If you’re adding a new library or contributing to the codebase, you need to fo
2323

2424
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.
2525

26-
Documentation contributions always use `develop` as the base branch. Make sure to also open your PR against the `develop` branch.
26+
Documentation contributions always use `main` as the base branch. Make sure to also open your PR against the `main` branch.
2727

2828
### Branch Name
2929

www/apps/docs/content/contribution/docs.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,7 @@ If you’re adding a new page or contributing to the codebase, you need to fork
5353

5454
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.
5555

56-
Documentation contributions always use `develop` as the base branch. Make sure to also open your PR against the `develop` branch.
57-
58-
### Branch Name
59-
60-
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/`.
56+
Documentation contributions always use `main` as the base branch. Make sure to also open your PR against the `main` branch.
6157

6258
### Pull Request Conventions
6359

0 commit comments

Comments
 (0)