Skip to content

Latest commit

 

History

History
104 lines (70 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

104 lines (70 loc) · 3.49 KB
Raw

Contributing to this project

Getting started

Before you begin –

  • Install the latest stable version of Node.js
  • Clone this repository using git clone [email protected]:getoslash/server-timify.git
  • Install all dependencies using npm install

Linting code

To check if your code is lint-free, run the command –

npm run lint

To try to auto-fix issues, run the command –

npm run lint:fix

To ensure all your TypeScript code is compliant, run the command –

npm run typecheck

Running all tests

To run all tests, run the command –

npm run test

Creating your first issue

Before you make your changes, check to see if an issue exists already for the change you want to make.

Don't see your issue? Open one

If you spot something new, open an issue using a template. We'll use the issue to have a conversation about the problem you want to fix.

Ready to make a change? Fork the repo

Fork using GitHub Desktop:

Fork using the command line:

  • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

Fork with GitHub Codespaces:

Make your update

Make your changes to the file(s) you'd like to update.

  • Are you making changes to the application code? You'll need Node.js to run the tests locally.
  • Are you contributing to markdown? We use GitHub Markdown.
  • Writing a Git commit message? We use the Angular commit convention.

Open a pull request

When you're done making changes and you'd like to propose them for review, use the pull request template to open your PR (pull request).

Submit your PR & get it reviewed

  • Once you submit your PR, project members will review it with you. The first thing you're going to want to do is a self review.
  • After that, we may have questions, check back on your PR to keep up with the conversation.
  • Did you have an issue, like a merge conflict? Check out GitHub's git tutorial on how to resolve merge conflicts and other issues.

Your PR is merged!

Congratulations! OSlash and the whole open-source community thanks you. :sparkles:

Once your PR is merged, you will be proudly listed as a contributor in the contributor chart.