Skip to content

Commit 9840656

Browse files
committed
docs: updated contributing guide to no longer contain the release section as this is not needed
1 parent f5d4d68 commit 9840656

File tree

2 files changed

+9
-15
lines changed

2 files changed

+9
-15
lines changed

COLLABORATOR_GUIDE.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,14 @@ As a collaborator, you will be involved with axios with some administrative resp
99
1. __Answer questions.__ It is not expected that you provide answers to questions that aren’t relevant, nor do you need to mentor people on how to use JavaScript, etc. If the question is not directly about the module, please close the issue. If the question stems from poor documentation, please update the docs and consider adding a code example. In any event try to be helpful and remember that there’s no such thing as a stupid question.
1010

1111
1. __Assist with PRs.__ By encouraging contributors to supply a PR for their own issue this is ideally where most of your attention will be focused. Keep a few things in mind as you review PRs.
12-
- When fixing a bug: does the PR adequately solve the problem without introducing any regressions?
13-
- When implementing a feature: does the feature fit within the scope of axios?
14-
- When removing functionality: is it properly deprecated with a warning?
15-
- When introducing functionality: is the API predictable?
16-
- Does the new code work for all supported platforms/browsers?
17-
- Do the tests and linting pass CI?
18-
- Are there tests to validate the changes that have been made?
12+
13+
- When fixing a bug: does the PR adequately solve the problem without introducing any regressions?
14+
- When implementing a feature: does the feature fit within the scope of axios?
15+
- When removing functionality: is it properly deprecated with a warning?
16+
- When introducing functionality: is the API predictable?
17+
- Does the new code work for all supported platforms/browsers?
18+
- Do the tests and linting pass CI?
19+
- Are there tests to validate the changes that have been made?
1920

2021
1. __Fix bugs and implement features.__ When things need to be fixed or implemented, and a PR can’t wait, you may do things yourself. You should still submit a PR yourself and get it checked off by at least one other contributor. Keep the points from number 4 in consideration as you push your code.
2122

CONTRIBUTING.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Please follow [conventional commits](https://www.conventionalcommits.org/en/v1.0
1212

1313
## Testing
1414

15-
Please update the tests to reflect your code changes. Pull requests will not be accepted if they are failing on [Travis CI](https://travis-ci.org/axios/axios).
15+
Please update the tests to reflect your code changes. Pull requests will not be accepted if they are failing on GitHub actions.
1616

1717
## Documentation
1818

@@ -28,13 +28,6 @@ Please update the [docs](README.md) accordingly so that there are no discrepanci
2828

2929
Please don't include changes to `dist/` in your pull request. This should only be updated when releasing a new version.
3030

31-
## Releasing
32-
33-
Releasing a new version is mostly automated. For now the [CHANGELOG](https://github.com/axios/axios/blob/master/CHANGELOG.md) requires being updated manually. Once this has been done run the commands below. Versions should follow [semantic versioning](http://semver.org/).
34-
35-
- `npm version <newversion> -m "Releasing %s"`
36-
- `npm publish`
37-
3831
## Running Examples
3932

4033
Examples are included in part to allow manual testing.

0 commit comments

Comments
 (0)