We would love for you to contribute to MicroAPI's Comments Microservice and help make it even better than it already is. As a contributor, here are the guidelines we would like you to follow:
For quick navigation:
- Code of Conduct
- Question or Problem?
- Found a bug?
- Missing feature?
- Submission Guidelines
- Commit Message Guidelines
- Implementation Guidelines
- Response Handlers
As a contributor, here are the guidelines we would like you to follow:
Please read and follow our code of conduct
Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on slack forum or google.
If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.
You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:
-
For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
-
Small Features can be crafted and directly submitted as a Pull Request.
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.
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we will systematically ask you to provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions.
A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.
We will be insisting on a minimal reproduction scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience, users often find coding problems themselves while preparing a minimal reproduction. We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it.
Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced.
You can file new issues by selecting from our new issue templates and filling out the issue template.
Before you submit your Pull Request (PR) consider the following guidelines:
-
Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.
-
Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design up front helps to ensure that we're ready to accept your work.
-
Make sure you sign with the primary email address of the Git identity that has been granted access to the team repository.
-
Fork repo.
-
Make your changes in a new git branch:
git checkout -b my-fix-branch master -
Create your patch, including appropriate test cases.
-
Run linting and ensure that all errors are fixed.
-
Run tests and ensure that all tests pass.
-
Commit your changes using a descriptive commit message
git commit -aNote: the optional commit -a command line option will automatically "add" and "rm" edited files.
-
Push your branch to GitHub:
git push origin my-fix-branch -
In GitHub, send a pull request to the appropriate branch (usually dev branch)
-
If we suggest changes, make the required updates.
-
Re-run the tests to ensure tests are still passing.
-
Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
git rebase master -i git push -f
That's it! Thank you for your contribution!
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
-
Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
git push origin --delete my-fix-branch -
Check out the master branch:
git checkout master -f -
Delete the local branch:
git branch -D my-fix-branch -
Update your master with the latest upstream version:
git pull --ff upstream master
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject as described below:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
The footer should contain a closing reference to an issue if any.
docs(changelog): update changelog to beta.5
fix(release): need to depend on latest rxjs and zone.js
For more examples and information, see conventional commits
Some implementation guidelines that you should take note of.
There are built-in handlers that should be used when implementing any code that requires a response to be sent back to the client. These handlers have specific responsibilities and the correct handler should be used. These handlers are meant to ensure that all responses conform to the same format.
See the utils folder in the root of the project to see the handlers.
An example of the CustomError handler:
// Invalid route error handler
app.use("*", (req, res, next) => {
const error = new CustomError(
404,
`Oops. The route ${req.method} ${req.originalUrl} is not recognised.`
);
next(error);
});