Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

64 lines (41 loc) · 2.64 KB

Contributing to NGcodeX

Thank you for considering contributing to NGcodeX! By participating in our community, you help us create a vibrant and collaborative environment. Before you begin, please take a moment to review our guidelines.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Issues and Pull Requests
  4. Setting up Your Environment
  5. Coding Standards
  6. Testing Guidelines
  7. Documentation
  8. Community Support

1. Code of Conduct

Please review and adhere to our Code of Conduct in all your interactions within the NGcodeX community.

2. How to Contribute

  1. Fork the NGcodeX repository to your GitHub account.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your contribution: git checkout -b feature/new-feature.
  4. Make your changes and commit them: git commit -m "Description of changes".
  5. Push the changes to your GitHub repository: git push origin feature/new-feature.
  6. Submit a pull request to the main NGcodeX repository.

3. Issues and Pull Requests

  • Issues: Use GitHub Issues to report bugs, suggest enhancements, or ask questions.
  • Pull Requests (PRs): Follow the PR template when submitting code changes. Provide a clear description of your changes and link to relevant issues.

4. Setting up Your Environment

  • Follow the instructions in the project's README to set up your development environment.
  • If specific dependencies or configurations are needed, they will be documented in the project.

5. Coding Standards

Follow our Coding Standards to maintain a consistent and high-quality codebase.

6. Testing Guidelines

Write tests for your code changes and ensure they pass before submitting a PR. Follow the Testing Guidelines for details.

7. Documentation

  • Update the documentation to reflect your changes.
  • If you're adding a new feature, include it in the relevant documentation.

8. Community Support

If you have questions or need assistance, reach out to the community:

  • Use the GitHub discussions.
  • Join our community chat on [Discord/WhatsApp/Telegram].
  • Email us at [contact@ngcodex.com].

Thank you for contributing to NGcodeX!

Note: NGcodeX reserves the right to update and modify these guidelines. Contributors will be notified of any significant changes.