mirrors/axios
2
0
Fork 0
mirror of https://github.com/tenrok/axios.git synced 2026-05-15 11:59:42 +03:00
Code Activity

docs: updated contributing guide to no longer contain the release section as this is not needed

Browse Source
This commit is contained in:
Jay
2022-05-28 17:51:14 +02:00
parent f5d4d688c1
commit 9840656c59
2 changed files with 9 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
COLLABORATOR_GUIDE.md
+8 -7
View File
@@ -9,13 +9,14 @@ As a collaborator, you will be involved with axios with some administrative resp
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.
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.
- When fixing a bug: does the PR adequately solve the problem without introducing any regressions?
- When implementing a feature: does the feature fit within the scope of axios?
- When removing functionality: is it properly deprecated with a warning?
- When introducing functionality: is the API predictable?
- Does the new code work for all supported platforms/browsers?
- Do the tests and linting pass CI?
- Are there tests to validate the changes that have been made?
- When fixing a bug: does the PR adequately solve the problem without introducing any regressions?
- When implementing a feature: does the feature fit within the scope of axios?
- When removing functionality: is it properly deprecated with a warning?
- When introducing functionality: is the API predictable?
- Does the new code work for all supported platforms/browsers?
- Do the tests and linting pass CI?
- Are there tests to validate the changes that have been made?
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.
CONTRIBUTING.md
+1 -8
View File
@@ -12,7 +12,7 @@ Please follow [conventional commits](https://www.conventionalcommits.org/en/v1.0
## Testing
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).
Please update the tests to reflect your code changes. Pull requests will not be accepted if they are failing on GitHub actions.
## Documentation
@@ -28,13 +28,6 @@ Please update the [docs](README.md) accordingly so that there are no discrepanci
Please don't include changes to `dist/` in your pull request. This should only be updated when releasing a new version.
## Releasing
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/).
- `npm version <newversion> -m "Releasing %s"`
- `npm publish`
## Running Examples
Examples are included in part to allow manual testing.