Skip to content

Latest commit

 

History

History
87 lines (59 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

87 lines (59 loc) · 3.15 KB

Contribute to Obsidian Chem

简体中文 | English

Design Philosophy

Before working on a new feature, I will consider the following criteria. The feature should meet at least one of them to be useful.

  • It helps with taking notes on chemical research, like experimental records, literature notes, paper writing, etc.
  • It promotes a workflow that integrates well with other chemistry tools.
  • It aids in learning chemistry and related subjects.

As an Obsidian plugin, this project adheres to the following principles:

  • Localize: Data should be kept local and standalone packages are preferred over remote services.
  • Leave No Trace: The plugin must not leave plugin-specific content in notes, allowing them to be shared with non-Obsidian users.
  • Plain Text Central: Plain text is preferred over complex formats.

How to report a bug or suggest a feature

  • Please use the issue tracker to report any problems or suggest new features.
  • Before creating a new issue, please search for existing issues to avoid duplicates.
  • When creating a new issue, please follow the templates to provide necessary information.
  • You can also vote for existing issues by adding a 👍 reaction to show your support.

You are also welcome to raise questions that you came across when using this plugin, or provide awesome showcases through issue!

How to submit a pull request

General

  • Before you start working, please announce that you want to do so by commenting on the issue.
  • Make small, focused changes on each PR.
  • If you are a beginner in plugin development, you can check the official developer documentation.

Clone the repo

cd [your-working-folder]

Note

It is recommended to use the config directory of a dev vault (e.g., .obsidian\plugins\) as the working directory.

git clone https://github.com/Acylation/obsidian-chem.git chem
cd chem

Note

The plugin id in the manifest is chem rather than obsidian-chem.

Install dependencies

npm install

Developing

npm run dev

Note

This command will listen for changes to the source code and provide a new build when you save changes.
Download and enable the Hot-Reload plugin to experience a smooth debugging workflow.

Linting and building

npm run lint
npm run build

Propose a Pull Request

  • Please include a clear and concise description of your changes in the pull request title and body.
  • Please reference any related issues in the pull request body using keywords like fixes #123, closes #456 and updates #789.
  • In source code, comments should only be used to explain unidiomatic code, declare and provide links to copied code, and describe the feature of a function or module.
  • For raising questions, providing suggestions, or explaining a specific line of code, please use GitHub’s code review feature.
  • Please wait for a review before your pull request being merged.

Thank you for being a part of this project! 🙌