Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (30 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

48 lines (30 loc) · 2.3 KB

Contributing to Codenight Developers

Welcome to Codenight Developers! We're thrilled that you're considering contributing to this open-source project. By contributing, you help improve the project for everyone. This document outlines some guidelines and information to make the contribution process smooth and effective.

How to Contribute

Creating an Issue

If you want to add new category or want to add new feature, please create an issue first. This will help us to understand your idea and we can discuss about it. To create an issue:

  1. Go to the Issues tab.
  2. Click on the "New Issue" button.
  3. Fill in the details including a descriptive title, the context, steps to reproduce (if applicable), and any supporting information.

Making Changes

To contribute changes to the project:

  1. Fork the repository to your GitHub account.
  2. Create a new branch (git checkout -b feature/add-new-feature).
  3. Add your details in the appropriate folder and name the file as your_github_username.md. DON'T CHANGE any json file.
  4. Make sure to follow the same format as other files and don't add a lot of details.
  5. Commit your changes (git commit -am 'Name added to Category X').
  6. Push to your branch (git push origin feature/add-new-feature).
  7. Open a pull request (PR) to the main branch.

Pull Requests (PRs)

When opening a PR, please ensure the following:

  • Provide a clear title like Add [Your Name] to [Category].
  • Reference related issues if applicable (e.g., "Fixes #12").
  • Ensure the files follows the project's coding style and guidelines.
  • Don't Create a new folder if you want that folder to be created, please create an issue first.

Code Review Process

All PRs will be reviewed by project maintainers. Feedback and changes may be requested. Please respond to comments and update the PR as necessary.

Code of Conduct

Please note that this project follows a Code of Conduct. By participating, you are expected to uphold this code.

Thank You

We appreciate your interest and contributions to Codenight Developers. Your efforts help improve the project and make it better for everyone. Thank you for being a part of this community!

If you have any questions or need assistance, feel free to reach out to us.