Neorg Project - Norgfmt (norg.py)

This is a Python project dedicated to parsing and formatting Neorg files. Our primary aim is to provide a reliable, efficient and highly customizable Neorg formatter which adheres to Pythonic standards and the Neorg Specification. The project is currently under active development with the parser under construction and the formatter yet to be started.

Project Structure

norg.py: The main Python script where parsing and formatting functions reside.

Getting Started

Clone the project: git clone https://github.com/nvim-neorg/norg.py.git
Navigate to the project directory: cd norg.py
Install the necessary requirements: poetry install

Contributing Guidelines

We welcome contributions from everyone. Here's how you can contribute:

Fork the Repository: You can fork the norg.py project on GitHub.
Clone the Project: Clone the forked repository to your local machine.
Create a Branch: Create a new branch for the features you're working on. This ensures that your changes are isolated and makes it easier for you to switch between different features.
Make Your Changes: Make your changes and try to follow the Pythonic standards outlined below.
Push Changes: Push your changes to your GitHub repository.
Submit a Pull Request: Submit a pull request for your changes on GitHub.

Please follow the below-mentioned standards and rules when contributing to this project:

Adhere to the Pythonic standards as outlined in PEP 8.
Follow the Neorg Specification.
Write clear, maintainable and efficient code.
Use descriptive variable and function names.
Provide clear comments and docstrings for your code.
Ensure test coverage for your code is over 50%.

Running Tests

Before submitting your pull request, make sure to run the tests and ensure they all pass:

poetry run pytest

Contact

For any issues or questions, please open an issue on this repository or contact the Neorg team, discord server : Neorg Server. We're always happy to help you!

Happy coding!

NTBBloodbath / norg.py