Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (33 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 2.08 KB

Contributing to CSSON

Thank you for considering contributing to CSSON! Your contributions help us improve and provide better functionality. Please follow the guidelines below to ensure a smooth process.

Commit Message Guidelines

When making commits, please use the following format for your commit messages:

  • Feature Commits: Use the prefix feat: for new features. Example: feat: implement something...

  • Fix Commits: Use the prefix fix: for bug fixes. Example: fix: correct typo in src/index.mjs

  • Refactor Commits: Use the prefix refactor: for code improvements that do not change functionality. Example: refactor: make code structure better

  • Chore Commits: Use the prefix chore: for routine tasks or maintenance. Example: chore: clean up unused stuff

  • Additions: Use the prefix add: for commits that include new code additions, such as functions, classes, or modules that enhance the project. Example: add: add: (addition)

  • Updates: Use the prefix update: for commits that modify existing functionality, improve performance, or make changes that are not new features but enhance the current implementation. Example: update: enhance user profile loading performance

  • Version Changes: Use the format 1.x.x for version bumps. Example: 1.6.7 - Added: (Addition)

Pull Request Guidelines

  1. Fork the Repository: Start by forking the repository to your own GitHub account.
  2. Create a Branch: Create a new branch for your feature or bug fix. Use a descriptive name that reflects the work you are doing.
  3. Make Your Changes: Implement your changes and ensure they follow the commit message guidelines above.
  4. Test Your Changes: If applicable, run tests to confirm your changes work as expected.
  5. Push Your Changes: Push your changes to your forked repository.
  6. Create a Pull Request: Submit a pull request to the main repository, providing a clear description of the changes and why they are necessary.

Thank you for contributing to CSSON! We appreciate your help in making our project better.