CONTRIBUTING.md

Contributing to api-dileepa-dev

Thank you for your interest in contributing to api-dileepa-dev! We welcome contributions, including bug fixes, feature enhancements, documentation improvements, and other general improvements.

Getting Started

1. Fork the repository
   Fork this repository to your GitHub account. This creates a copy of the repository in your account, allowing you to make changes without affecting the original repository.
   To fork the repository, click the Fork button in the top right corner of this page or click here to fork the repository.

2. Clone your fork
   Clone your forked repository to your local machine using the following command:

   git clone https://github.com/<your-username>/api-dileepa-dev.git

3. Create a new branch
   Create a new branch for your changes. Follow the branch naming guidelines.

   git checkout -b your-branch-name

4. Make changes and commit
   Make your changes and commit them with a descriptive commit message. Follow the commit message guidelines.

   git commit -m "feat: Add a new feature"

5. Push your changes
   Push your changes to your forked repository.

   git push origin your-branch-name

6. Submit a pull request
   To submit a pull request:

   • Go to your forked repository.
   • Click the Compare & pull request button next to your your-branch-name.
   • Add a title and description for your pull request. Follow the pull request guidelines.
   • Click Create pull request and remember to add the relevant labels using the pull request template.

Guidelines

• Follow the project's code style.
• Update documentation if necessary.
• Add tests if applicable.
• Ensure all tests pass before submitting your changes.
• Keep your pull request focused and avoid unrelated changes.
• Refer to the following templates and guidelines before submitting your changes:
  • api-dileepa-dev/ - Root directory of the repository
    • .github/ - GitHub-specific files (workflows, templates, etc.)
      • ISSUE_TEMPLATE/ - Contains all issue templates
        • bug_report.md - Template for reporting bugs
        • documentation_update.md - Template for documentation updates
        • feature_request.md - Template for suggesting new features
        • feedback.md - Template for general feedback
        • other.md - Template for other types of issues
      • PULL_REQUEST_TEMPLATE.md - Template for pull request submissions
    • BRANCH_NAMING_GUIDELINES.md - Branch naming rules
    • CHANGELOG.md - Record of project changes
    • CODE_OF_CONDUCT.md - Contributor behavior guidelines
    • COMMIT_MESSAGE_GUIDELINES.md - Rules for writing commit messages
    • CONTRIBUTING.md - How to contribute to the project
    • LICENSE - Project license
    • PULL_REQUEST_GUIDELINES.md - Pull request submission guidelines
    • README.md - Project overview
    • SECURITY.md - Security policy and reporting
    • TODO.md - Tasks planned for future releases
    • VERSIONING.md - Versioning strategy for the project

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you agree to abide by its terms.
Read the full Contributor Covenant Code of Conduct in the CODE_OF_CONDUCT.md file.

Contact

If you have any questions or suggestions regarding these community standards, feel free to open an issue or submit a pull request in this repository.

You can also reach me via email at: contact@dileepa.dev