Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 2.14 KB

Contribution Guidelines

Ways to Contribute:

There are several ways you can contribute to Nyxtext:

  1. Code Contributions: Fix bugs, implement new features, or improve existing functionality by submitting pull requests.

  2. Documentation: Help improve the project's documentation by fixing errors, adding missing information, or clarifying existing content.

  3. Bug Reporting: Report bugs, issues, or unexpected behavior you encounter while using Nyxtext. Please provide detailed steps to reproduce the issue.

  4. Feature Requests: Suggest new features, enhancements, or improvements you'd like to see in Nyxtext. Describe the feature and its potential benefits.

Code Guidelines:

When contributing code to Nyxtext, please adhere to the following guidelines:

  • Write clear and concise code with meaningful variable names and comments where necessary.
  • Test your changes thoroughly to ensure they do not introduce regressions or break existing functionality.

To get started, make a fork of Nyxtext with the button in the top right corner of this page. Then install Python and git, and run these commands:

    git clone https://github.com/parazeeknova/nyxtext.git
    cd nyxtext
    python3 -m venv env
    source env/bin/activate
    pip install -r requirements.txt
    python3 -m editor/scripts/main.py

This should run Nyxtext. If you change some of Nyxtext's code in the nyxtext directory and you run python3 -m editor/scripts/main.py again, your changes should be visible right away.

Windows-specific notes:

  • You need to use py instead of python3 when creating the venv, and env\Scripts\activate instead of source env/bin/activate to activate it.
  • If creating the venv fails with an error message like Error: [Errno 13] Permission denied: ...\\python.exe, try creating the venv into a different folder. It is created into whatever folder you are currently cd'd to (i.e. the folder that shows up on the command prompt before the >).