Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 4.56 KB

contributing.md

File metadata and controls

63 lines (47 loc) · 4.56 KB
Raw

Contributing to RaccoonChessSigma

RaccoonChessSigma is a MIT Licensed project and uses the standard GitHub pull requests process to review and accept contributions.

There are several areas of RaccoonChessSigma that could use your help. For starters, you could help in improving the sections in this document by either creating a new issue describing the improvement or submitting a pull request to this repository.

  • If you are a first-time contributor, please see Steps to Contribute.
  • If you have a question about RaccoonChessSigma and cannot find the answer in the documentation? Use the Ask a Question template and fill out the required fields.
  • If you find a defect, use the Bug Report template to submit any bugs. Provide as much details as possible about the issue encountered, your environment, steps to reproduce the issue, screenshots, logs, stack traces, and anything else that can describe the problem. The more details are initially provided, the faster the bug can be reproduced and triaged.
  • If you have any idea on how to improve RaccoonChessSigma (nothing is too crazy 😀), open a Feature Request and submit your idea to the community. As with defects, a detailed description of your feature request will help maintainers evaluate the value and feasibility of your request more quickly. When a request has been reviewed and accepted, it will be being scheduled for a future release, resulting in a related pull request.
  • If you discovered a security vulnerability in this project? We ask you to alert the maintainers by sending an email describing the issue, impact, and fix - if applicable. You can reach RaccoonChessSigma maintainers on the mailing lists
  • If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See Sign your work.

Steps to Contribute:

  • Find an issue to work on or create a new issue.
  • Claim your issue by commenting your intent to work on it to avoid duplication of efforts.
  • Fork this repository (also star 😉).
  • Create a branch from where you want to base your work (usually main).
  • Make your changes.
  • Review recommended TypeScript Coding Style and Unit Testing
  • Commit your changes by making sure the commit messages convey the need and notes about the commit.
  • Push your changes to the branch in your fork of the repository.
  • Submit a pull request to the original repository. See Pull Request checklist

Pull Request Checklist:

  • Rebase to the current main branch before submitting your pull request.
  • Commits should be as small as possible. Each commit should follow the checklist below:
    • For code changes, add tests relevant to the fixed bug or new feature
    • Pass the GitHub Test - includes spell checks, testing, coverage, etc
    • Commit header (first line) should convey what changed
    • DCO Signed

Signing your commits

All contributors to the RacoonChessSigma retain copyright to their work. However, to ensure that they are only submitting work that they have rights to, we are requiring everyone to acknowledge this by signing their work. This way of certifying is commonly known as the Developer Certificate of Origin (DCO). We encourage all contributors to read the DCO text before signing a commit and making contributions.

To sign your work, just add a line like this at the end of your commit message:

My Commit Message

Signed-off-by: Jane Smith <jane.smith@example.com>

Please use your real name (sorry, no pseudonyms or anonymous contributions). If you've already set up your GitHub username and e-mail address, signing can easily be done with the --signoff or -S option to git commit:

$ git commit -S -m your commit message
# This will automaticlly Creates a signed commit

Building, Deploying, and Testing

Please refer to the Getting Started Guide for information on building, deploying, and running tests.