|
1 | 1 | # Contributing
|
2 | 2 |
|
3 |
| -When contributing to this repository, please first discuss the change you wish to make via issue, |
4 |
| -email, or any other method with the owners of this repository before making a change. |
5 |
| - |
6 | 3 | Please note we have a code of conduct, please follow it in all your interactions with the project.
|
7 | 4 |
|
8 |
| -## Pull Request Process |
| 5 | +## Submission guidelines |
| 6 | + |
| 7 | +### Submitting an issue |
| 8 | + |
| 9 | +Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists, and the discussion might inform you of workarounds readily available. |
| 10 | + |
| 11 | +Please provide steps to reproduce if you found a bug or ideally fork the repository and add a failing test that demonstrates what is wrong. This will help us understand and fix the issue faster. |
| 12 | + |
| 13 | +### Submitting a pull request |
| 14 | + |
| 15 | +Before you submit your pull request, consider the following guidelines: |
| 16 | + |
| 17 | +- Search [GitHub](https://github.com/apify/apify-sdk-js/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort. |
| 18 | + |
| 19 | +- Fork the project and install NPM dependencies. |
| 20 | + |
| 21 | +- Run tests before you start working, to be sure they all pass and your setup is working correctly: |
| 22 | + |
| 23 | + ```sh |
| 24 | + npm run test |
| 25 | + ``` |
| 26 | + |
| 27 | +- Be sure to **include appropriate test cases**. Tests help make it clear what the PR is fixing and also make sure the changes won't break over time. |
| 28 | +- Commit your changes using a descriptive commit message that follows defined [commit message conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.uyo6cb12dt6w). Adherence to these conventions is necessary because release notes are automatically generated from these messages. |
| 29 | +- Push the code to your forked repository and create a pull request on GitHub. |
| 30 | +- If somebody from project contributors suggests changes: |
| 31 | + - Make the required updates. |
| 32 | + - Re-run all test suites to ensure tests are still passing. |
| 33 | + - Commit them and push. Don't rebase after you get a review, so it is clear what changes you did in the last commit. The PR will be squash merged, so its history is irrelevant. |
9 | 34 |
|
10 |
| -1. Ensure any install or build dependencies are removed before the end of the layer when doing a |
11 |
| - build. |
12 |
| -2. Update the README.md and CHANGELOG.md with details of changes to the interface, this includes new environment |
13 |
| - variables, exposed ports, useful file locations and container parameters. |
14 |
| -3. Increase the version numbers in any examples files and the README.md to the new version that this |
15 |
| - Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). |
16 |
| -4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you |
17 |
| - do not have permission to do that, you may request the second reviewer to merge it for you. |
| 35 | +That's it! Thank you for your contribution! |
18 | 36 |
|
19 | 37 | ## Code of Conduct
|
20 | 38 |
|
|
0 commit comments