Skip to content

Latest commit

 

History

History
117 lines (93 loc) · 4.88 KB

CONTRIBUTING.md

File metadata and controls

117 lines (93 loc) · 4.88 KB
Raw

Contribution Guidelines

Note: If these contribution guidelines are not followed your issue or PR might be closed, so please read these instructions carefully.

Contribution types

Bug Reports

  • If you find a bug, please first report it using Github issues.
    • First check if there is not already an issue for it; duplicated issues will be closed.

Bug Fix

  • If you'd like to submit a fix for a bug, please read the How To for how to send a Pull Request.
  • Indicate on the open issue that you are working on fixing the bug and the issue will be assigned to you.
  • Write Fixes #xxxx in your PR text, where xxxx is the issue number (if there is one).
  • Include a test that isolates the bug and verifies that it was fixed.

New Features

  • If you'd like to add a feature to the library that doesn't already exist, feel free to describe the feature in a new GitHub issue.
  • If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending too much time writing the code. In some cases, enhancements may not align well with the project objectives at the time.
  • Implement the code for the new feature and please read the How To.

Documentation & Miscellaneous

  • If you have suggestions for improvements to the documentation, tutorial or examples (or something else), we would love to hear about it.
  • As always first file a Github issue.
  • Implement the changes to the documentation, please read the How To.

How To Contribute

Requirements

For a contribution to be accepted:

  • Documentation should always be updated or added.*
  • Examples should always be updated or added.*
  • Tests should always be updated or added.*
  • Format the TS code accordingly with npm run format && npm run lint.
  • Your code should pass the analyzer checks when a PR is submitted
  • Your code should pass all tests npm run test.
  • Your code should has 100% coverage
  • Start your PR title with a conventional commit type (feat:, fix: etc).

*When applicable.

If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the issue or PR. You can still continue to add more commits to the branch you have sent the Pull Request from and it will be automatically reflected in the PR.

Open an issue and fork the repository

  • If it is a bigger change or a new feature, first of all file a bug or feature report, so that we can discuss what direction to follow.
  • Fork the project on GitHub.
  • Clone the forked repository to your local development machine (e.g. git clone git@github.com:<YOUR_GITHUB_USER>/penseapp/discord-notification.git).

Environment Setup

Discord notification uses Npm to manage the project and dependencies.

To install npm, install NVM, after the install run:

nvm install 14
nvm use 14
npm -v

Next, at the root of your locally cloned repository, install dependencies using NPM

npm i

Performing changes

  • Create a new local branch from master (e.g. git checkout -b feat/my-new-feature)
  • Make your changes.
  • When committing your changes, make sure that each commit message is clear (e.g. git commit -m 'feat: Implements a new function XYZ').
  • Push your new branch to your own fork into the same remote branch (e.g. git push origin my-username.my-new-feature, replace origin if you use another remote.)

Open a pull request

Go to the pull request page of Discord Notification and in the top of the page it will ask you if you want to open a pull request from your newly created branch.

The title of the pull request should start with a conventional commit type.

Examples of such types:

  • fix: - patches a bug and is not a new feature.
  • feat: - introduces a new feature.
  • docs: - updates or adds documentation or examples.
  • test: - updates or adds tests.
  • refactor: - refactors code but doesn't introduce any changes or additions to the public API.

If you introduce a breaking change the conventional commit type MUST end with an exclamation mark (e.g. feat!: Remove the position argument from PositionComponent).

Examples of PR titles:

  • feat: Add author option to the discord
  • fix: AvatarUrl not showing correctly
  • docs: Improve the README on the section XYZ
  • test: Add scenario XYZ test for DiscordNotification.spec.ts
  • refactor: Optimize the structure of app
  • chore: add a new pipeline