diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..0582619 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing to This Project + +Thank you for your interest in contributing to this project! Please read the following guidelines to understand how you can contribute. + +## Private Repository + +This is a **private repository**. While you're welcome to file issues and suggest ideas, please note that this project is primarily a personal endeavor. Contributions from the community are appreciated, but they might not always be incorporated. + +## Filing Issues + +If you encounter any issues or have suggestions for improvements, feel free to [open an issue](https://github.com/your-repo/issues) (or email me). Please be as detailed as possible when describing the problem or idea. I appreciate your input! + +## Contributing Fixes + +If you have a fix that you'd like to contribute: +- Please do **not** submit a pull request directly. +- Instead, email the developer at [developer@itzilly.com](mailto:developer@itzilly.com) with details about your fix. +- If the fix aligns with the project's goals and standards, you'll receive guidance on how to proceed. + +## Suggesting Ideas + +I welcome ideas and suggestions! However, please keep in mind: +- This project is more of a personal project, so while all ideas are welcome, not every suggestion will be implemented. +- Feel free to suggest ideas by [opening an issue](https://github.com/404) and detailing your thoughts. + +## Code of Conduct + +Please remember to be respectful and constructive when engaging with this project. At the end of the day, this is just my project. + +Thank you for your understanding and for contributing to this project! + +# Note for persons with a Gitea account +If you have access to an account with elevated permissions on this repo, you're welcome to commit code/make pull requests. diff --git a/docs/DEVELOPER_NOTICE.md b/docs/DEVELOPER_NOTICE.md new file mode 100644 index 0000000..7f88bac --- /dev/null +++ b/docs/DEVELOPER_NOTICE.md @@ -0,0 +1,55 @@ +# Developer Notice + +Welcome to my project! This is primarily a personal project, and while I'm happy to have others take an interest, it's important to follow the guidelines below to ensure consistency and maintainability. (This is mostly for my reference) + + +## Conventional Commits + +I use [Conventional Commits](https://www.conventionalcommits.org/) for all commit messages. This means that every commit should follow this format: + +``` +(): +``` +- **Type:** The type of change you're committing. Common types include `feat` (new feature), `fix` (bug fix), `docs` (documentation only changes), `style` (code style, formatting, etc.), `refactor` (refactoring code), `test` (adding or updating tests), and `chore` (other changes that don't modify src or test files). +- **Scope:** An optional field that describes the part of the codebase the change affects (e.g., `api`, `config`, `ui`). +- **Description:** A brief description of the change. + +Example commit message: + +``` +feat(api): add new endpoint for user data +``` + +``` +chore(release): bump version to 1.4.3 +``` + +``` +style(ui): clean up redundant CSS classes in header component +``` + +``` +fix(auth): resolve login redirect loop issue +``` + +``` +merge(pr-45): integrate feature-x from pull request #45 +``` + + +## Branching Strategy + +Branches are primarily for adding new features. However, while the project is in pre-release, it's okay to work on minor features directly on the `main` branch. Just make sure you: + +- Commit all changes for the feature at once. +- Avoid having partial changes spread across multiple commits. Each commit should represent a complete and functional piece of work. + +## Versioning + +The versioning scheme I use is simple: + +- **Patch version:** Bumped when small, incremental changes or bug fixes are made. For example, `x.x.y` to `x.x.y + 1`. +- **Minor version:** Typically, if a feature is added or updated, the version may stay the same until the project exits pre-release. Version `2.x.x` will be used if the project ever gets out of pre-release. +- **Major version:** Reserved for significant changes, like command updates, configuration overhauls, or substantial new features. + +Remember, this is my project, so while I'm open to contributions and suggestions, I maintain the final say on what gets merged or included. Thanks for your understanding and contributions!