Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (55 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

67 lines (55 loc) · 2.76 KB
Raw

Contributing to ARCWorks Simple Dictionary

First off, thank you for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create.

Here is a guide on how you can contribute to this project.

Code of Conduct

By participating in this project, you agree to maintain a respectful, welcoming, and professional environment for everyone.

How Can I Contribute?

Reporting Bugs

If you find a bug in the application, please open an issue on GitHub. Before opening a new issue, please search existing issues to see if the problem has already been reported.

When reporting a bug, please include:

  • A clear description of the bug.
  • Steps to reproduce the bug.
  • Expected behavior vs. actual behavior.
  • Screenshots or error logs (if applicable).
  • Your operating system version.

Suggesting Enhancements

We welcome ideas for new features! To suggest an enhancement, please open an issue and:

  • Describe the feature you would like to see.
  • Explain why this feature would be useful.
  • Describe how it should work or look (mockups are welcome!).

Pull Requests

If you want to contribute code changes:

  1. Fork the Repository: Create your own copy of this repository on GitHub.
  2. Clone Locally: Clone your fork to your computer. 
    git clone https://github.com/your-username/ARCWorks-Simple-Dictionary.git
cd ARCWorks-Simple-Dictionary
  3. Install Dependencies: Install the required development packages. 
    npm install
  4. Create a Branch: Create a branch for your feature or bug fix. 
    git checkout -b feature/your-feature-name
  5. Implement Changes: Add your code. Make sure to follow the design aesthetics:
    • Visual changes should respect the leather-and-gold storybook theme defined in renderer/style.css using CSS custom properties (:root).
    • Keep the codebase lightweight, offline-first, and performant.
  6. Test Your Changes: Run npm start to open the app locally and verify everything works as expected.
  7. Commit & Push: Commit your changes with a clear commit message and push to your fork. 
    git add .
git commit -m "Add: detailed description of your changes"
git push origin feature/your-feature-name
  8. Open a Pull Request: Go to the original repository on GitHub and open a pull request from your branch.

Development Workflows

  • Run Dev Mode: npm start
  • Rebuild JSON Dictionary: If you modify the CSV source data at data/OPTED-Dictionary.csv, run: 
    npm run rebuild-data
  • Package for Windows (Directory): npm run dist
  • Create Installer: Open installer/setup.iss in Inno Setup and compile.

Thank you for contributing to ARCWorks Simple Dictionary!