Skip to content

Latest commit

 

History

History
106 lines (72 loc) · 6.21 KB

CONTRIBUTING.md

File metadata and controls

106 lines (72 loc) · 6.21 KB

Contributing To Dev Cheats

:octocat: Thanks for taking the time to contribute!

The following is a set of guidelines for contributing to this repository.

Code of Conduct

This project and everyone participating in it is governed by the Dev Cheats Code of Conduct. By participating, you are expected to uphold this code.

Issues

Reporting Bugs

Before creating bug reports, please perform a cursory search on issues to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for will help maintainers resolve it faster.

To report a new issue, please follow these steps:

  • Use a clear and descriptive title for the issue to identify the problem after the prefix of [BUG]
  • Use the bug report template and fill out the required fields.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started the app, e.g. which command exactly you used in the terminal. When listing steps, don't just say what you did, but explain how you did it.
  • Explain the expected behaviour
  • Provide your OS and Browser information.
  • Add any additional Context about the problem here such as console logs and screenshots. If you do not know how to get the console logs, please check your browser's documentation on how to get the console logs. If you cannot find the console logs, please mention that in the issue so that maintainers can help you get the logs.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Documentation Requests

Before suggesting a documentation request, please perform a cursory search on issues to see if the suggestion has already been submitted. When you are creating a documentation request, select the documentation template and fill out the fields.

  • Provide the name of the app / tool after the prefix of [DOCS] for title
  • Provide the official website or repository link of the app / tool
  • Provide the official documentation link if exists
  • If any, provide additional context or information that may be useful for the documentation

Feature Requests

Before suggesting an enhancement or feature request, please perform a cursory search on discussions to see if the suggestion has already been submitted.

  • User a clear descriptive title for the suggestion
  • Describe the current behavior and explain which behavior you expected to see instead and why
  • Provide any additional context for the enhancement or feature request if possible

If maintainers approve your suggestion, the discussion will be converted to an issue and will be added to the backlog as an enhancement.

Contributing To Source Code

In order to contribute to the source of the project

  1. Fork the repository and create a new branch for your feature or enhancement kebab-case for the branch name
    • For new documents, please use the docs-app-name as the branch name.
    • For features or enhancements, please use the feat-feat-name as the branch name.
  2. Use commit messages guideline for your commits.
  3. Send a pull request to the main branch using the pull request guideline.

New Documents

I really appreciate contributions in the form of new documents to the project. If you'd like to add a new document, please follow these steps:

  1. Create a new json file in the public/data/docs folder using the app's name as the file name. Please use kebab-case for the file name. You can use the template.json file as a starting point.
  2. Add the name of the new command to the public/data/list.json file to enable autosuggest functionality.

More information can be found in the Wiki Page.

New Features / Enhancements

Any new features or enhancements should be discussed in discussions first.

  1. Create a new idea and describe the feature or enhancement you'd like to work on.
  2. Wait for the idea to be approved by a maintainer.
  3. If the idea is approved, the discussion will be converted to an issue and will be added to the backlog as an enhancement.
  4. Fork the repository and create a new branch for your feature or enhancement.
  5. Use commit messages guideline for your commits.
  6. Send a pull request to the main branch using the pull request guideline.

Commit and PR Guidelines

Commit Messages

When writing commit messages, please follow these guidelines:

  • 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

Pull Requests

While creating a Pull Request, please use the provided pull request tempalte and keep the following guidelines in mind:

  • Do not change design into a complicated and / or overwhelming experience
  • Do not include issue numbers in the PR title if any
  • If applicable, include screenshots or animated GIFs to showcase new features