Skip to content

Latest commit

 

History

History
175 lines (123 loc) · 9.7 KB

CONTRIBUTING.md

File metadata and controls

175 lines (123 loc) · 9.7 KB
Raw

Contributing to Logseq

Thanks for your interest! ❤️ 🕺 💃 We would love for you to contribute to Logseq and help make it even better than it is today!

As a contributor, here is an overview of things to learn about and ways to get involved:

Code of Conduct

Help us keep Logseq open and inclusive. Please read and follow our Code of Conduct.

How can I help?

There are many ways you can help. Here are some ways to help without coding:

For ways to help with coding, read the next section.

Code Contributions

For contributors who want to help with coding, we have a list of good first issues to help you get started. These are issues that are beginner-friendly and do not require advanced knowledge of the codebase. We encourage new contributors to start with these issues and gradually work their way up to more challenging tasks. We also have a project board to keep track of community contributions Logseq - Develop Together 💪. Another way to help with coding is by extending Logseq with plugins and submitting them to the marketplace so that the whole community can benefit.

Got a Question or a Problem?

Please do not open issues for general support questions or feature requests as we want to keep GitHub issues for bug reports. Instead, we recommend using Logseq forum to ask support-related questions.

The Logseq forum is a much better place to ask questions since:

  • there are more people willing to help on the forum
  • questions and answers stay available for public viewing so your question/answer might help someone else
  • The forum's voting system assures that the best answers are prominently visible.

To save your and our time, we will systematically close all issues that are requests for general support and redirect people to the forum.

If you would like to chat about the question in real-time, you can reach out via our Discord server.

Found a Bug?

If you find a bug, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Missing a Feature?

You can request a new feature by Creating a thread in our forum. If you would like to implement a new feature, please open an issue and outline your proposal so that it can be discussed.

Submit an Issue

Before you submit an issue, please search the issue tracker. An issue for your problem might already exist and the discussion might inform you of workarounds readily available.

To submit an issue, fill out the bug report template. Please file a single issue per problem and do not enumerate multiple bugs in the same issue.

The template will ask you to include the following with each issue:

  • Version of Logseq
  • Your operating system
  • List of extensions that you have installed. Attempt to recreate the issue after disabling all extensions.
  • Reproducible steps (1... 2... 3...) that cause the issue
  • What you expected to see, versus what you actually saw
  • Images, animations, or a link to a video showing the issue occurring
  • A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally
    • Note: Because the developers need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient.
  • Errors from the Dev Tools Console (open from the menu: View > Toggle Developer Tools or press CTRL + Shift + i)

Submit a Pull Request (PR)

Before working on your pull request, please check the following:

  1. Search GitHub for related PRs that may affect your submission.

  2. Be sure that an issue describes the problem you're fixing or the feature behavior and design you'd like to add.

  3. Please sign our Contributor License Agreement (CLA). We cannot accept code without a signed CLA.

After doing the above, you are ready to work on your PR! To create a PR, fork this repository and then create a branch for the fix. Once you push your code to your fork, you'll be able to open a PR to the Logseq repository. For more info, you can follow this GitHub guide. For more github PR guides, see these guides.

PR Guidelines

When submitting a Pull Request (PR) or expecting a subsequent review, please follow these guidelines:

  1. The PR is ready for review. If you have work you know how to do, then please keep your changes local until they are ready. If you need help with your PR, feel free to submit with questions.

  2. The PR checks which include tests and lint checks are passing.

  3. The PR has no merge conflicts.

  4. The PR has test(s) for features or enhancements. Tests for bug fixes are also appreciated as they help prevent regressions.

  5. The PR has a descriptive title that a user can understand. We use these titles to generate changelogs for the user. Most titles use one of these prefixes to categorize the PR e.g. PREFIX: DESCRIPTION ...:

    • chore - Misc changes that aren't dev, feat or fix
    • dev - Developer related changes
    • enhance - Enhancements i.e. changes to existing features
    • feat or feature - New features
    • fix - Bug fixes
    • test - Test only changes

  6. The PR having "allow edits from maintainers" enabled would be appreciated. Helps us help your contribution.

  7. The PR avoids the following changes that are not helpful to the core team:

    • Unrelated refactoring or heavy refactoring
    • Code or doc formatting changes including whitespace changes
    • Dependency updates e.g. in package.json
    • Changes that contain multiple unverified resources. This is risky for our users and is a lot of work to verify. A change with one resource that can be verified is acceptable.

PR Additional Links

Sign the CLA

Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code changes to be accepted, the CLA must be signed. It's a quick process, we promise!

If you have more than one GitHub account or multiple email addresses associated with a single GitHub account, you must sign the CLA using the primary email address of the GitHub account used to author Git commits and send pull requests.

The following documents can help you sort out issues with GitHub accounts and multiple email addresses:

Thank You

Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.