Skip to content

Latest commit

 

History

History
54 lines (49 loc) · 3.28 KB

CONTRIBUTING.md

File metadata and controls

54 lines (49 loc) · 3.28 KB

Contributing to Sudocode

The following is a set of guidelines for contributing to Sudocode.These are mostly guidelines, not rules.

What should I know before I get started?

Sudocode

Sudocode is an open source project.Sudocode, as the name suggests, is the supreme coding tool for everyone. Using sudocode, one actually need not learn how to code in C or C++. This particular tool helps you with converting your pseudocode to code. All you need to do is follow some rules which are mentioned in the README.md file and you'll be good to go.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Sudocode. Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Sudocode, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion memo and find related suggestions mag_right.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of Sudocode which the suggestion is related to.
  • Explain why this enhancement would be useful to most Sudocode users.

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.
  • When only changing documentation, include [ci skip] in the commit title.
  • Consider starting the commit message with an applicable emoji:
  • art 🎨 when improving the format/structure of the code.
  • racehorse 🐎 when improving performance.
  • non-potable_water 🚱 when plugging memory leaks.
  • memo 📝 when writing docs.
  • penguin 🐧 when fixing something on Linux.
  • apple 🍎 when fixing something on macOS.
  • checkered_flag 🏁 when fixing something on Windows.
  • bug 🐛 when fixing a bug.
  • fire 🔥 when removing code or files.
  • green_heart 💚 when fixing the CI build.
  • white_check_mark ✅ when adding tests.
  • lock 🔒 when dealing with security.
  • arrow_up ⬆️ when upgrading dependencies.
  • arrow_down ⬇️ when downgrading dependencies.
  • shirt 👕 when removing linter warnings. Thanks!