What should I know before I get started?
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.
Please report unacceptable behavior to [email protected].
To setup Hackernews UI on your machine go through the installation guide.
Please make sure you go through the issues and pull requests before reporting a bug. There could be a chance that someone might already have reported a bug. When you are creating a bug report, please include as many details as possible.
Explain the problem and include additional details to help maintainers reproduce the problem.
If you have any suggestions or new feature requests, create an issue. Try to explain why the feature is important and how it helps.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move file to..." not "Moves file to...")
Be Consistent. If you're writing/editing code, take a few minutes to look at the code around you and determine it's style. If the code use spaces around if clauses, you should too. If the comments have little boxes of stars around them, make your comments have little boxes of stars around them too.
If the code you add to a file looks drastically different from the existing code around it, it throws readers out of their rhythm when they to read it.
We suggest you to yarn lint:fix your code before commit. This command will try to fix common linter issues automatically.
Here are some linting rules we enforce in the app APP.
Make sure you properly document the code you've written. For more information on how to properly document your code click here.
Example:
/**
* Hit the twilio API to send notifications.
*
* @param {Object} payload
* @returns {Promise}
*/
function sendNotification(payload) {
return twilioClient.sendMessage(payload);
}We recommend you to write tests for any changes you've made. If you are not good at writing tests feel free to start a discussion. We will be happy to help.
Licensed under The License.