There are several ways you can contribute to Nyxtext Zenith, including but not limited to the following:
-
Code Contributions: Fix bugs, implement new features, or improve existing functionality by submitting pull requests.
-
Documentation: Help improve the project's documentation by fixing errors, adding missing information, or clarifying existing content.
-
Bug Reporting: Report bugs, issues, or unexpected behavior you encounter while using NyxNote. Please provide detailed steps to reproduce the issue.
-
Feature Requests: Suggest new features, enhancements, or improvements you'd like to see in Nyxtext Zenith. Describe the feature and its potential benefits.
When contributing code to Nyxtext Zenith, 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 Zenith 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-zenith.git
cd nyxtext
python3 -m venv env
source env/bin/activate
pip install -r requirements.txt
python -m zenith
This should run Nyxtext Zenith. If you change some of Nyxtext Zenith's code in the zenith
directory and you run python -m zenith
again, your changes should be visible right away.
Windows-specific notes:
- You need to use
py
instead ofpython3
when creating the venv, andenv\Scripts\activate
instead ofsource 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 currentlycd
'd to (i.e. the folder that shows up on the command prompt before the>
).