Skip to content

Latest commit

History

History
executable file
67 lines (37 loc) 路 2.9 KB

CONTRIBUTING.md

File metadata and controls

executable file
67 lines (37 loc) 路 2.9 KB

Contributing

Do you like this library and want to get involved? We would love for you to contribute and help make it even better. As a contributor, here are the guidelines we would like you to follow.

Code of Conduct

This library is open and inclusive. Please read and follow our Code of Conduct.

Questions

First make sure your question is entirely related to this library and not to MongoDb or Multer. You can find answers for those in StackOverflow and GitHub.

Search the issues, even the closed ones using keywords for your problem. There is a possibility that someone had the same problem before and there is already a fix available. Also try StackOverflow, you will find thousands of developers willing to help there and the solutions might help other people with the same problem as you.

Bugs and features

If you found a bug you are welcome to report it submitting an issue. You can also open a pull request if you are confident you can fix it but make sure to open the issue first and discuss the problem. The same applies for new features big or small. This helps coordinate our efforts and prevent duplication of work.

Try not to pollute your changes trying to address several issues at once. Keep them simple and focused on one single problem. You can open a new PR or issue to solve the others.

Provide a demo via a GitHub repo or RunKit with the problem you found. We need to confirm it actually exist before proceeding to fix it. Saving us time will serve to fix more bugs and help more people.

Pull request

Make sure you follow all of the steps mentioned here as they ensure your changes are accepted and merged quickly:

Click the Fork button to create your personal fork of this repository

Clone your copy using git

Run npm install to download and install dependencies.

Create a new branch for your changes

git checkout -b my-fix-branch master

Fix the bug or add the feature you want

Add the required tests to make sure your code works and run the test suite ensuring all tests pass.

ng test

If possible make sure code coverage didn't diminished. There are tasks available for that too. Execute npm run coverage and serve the coverage folder with your preferred web server for static assets.

Lint the code using the task npm run lint and fix the issues that cannot be solved automatically.

Commit your changes using a descriptive commit message that give us an idea of what you did

Push your branch to GitHub

git push origin my-fix-branch

Open GitHub and send a pull request to the master branch. You could also sent it to develop if is a work in progress.

Check the results from the Travis CI tests

Keep adding commits with more changes if needed.

After the pull request is merged, you can delete your branch and update your local copy from the upstream repository.