Skip to content

Latest commit

 

History

History
71 lines (56 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

71 lines (56 loc) · 2.29 KB

Contributing to Project-N

Thank you for considering contributing to Project-N! We welcome and appreciate contributions from the community to improve and expand this project.

How to Contribute

1. Fork the Repository

To contribute, first fork the repository to your GitHub account by clicking the Fork button on the top right corner of the repository page.

2. Clone the Repository

Clone your forked repository to your local machine:

    git clone https://github.com/your-username/Project-N.git
    cd Project-N

3. Create a New Branch

Create a new branch for your contribution:

    git checkout -b feature-or-bugfix-name

4. Make Your Changes

Make necessary changes, ensuring that:

  • Code follows the project structure and coding guidelines.
  • TypeScript and ESLint rules are followed.
  • Changes are properly documented and tested.

5. Commit Your Changes

Commit messages should be clear and descriptive:

    git add .
    git commit -m "Add feature/fix bug: short description"

6. Push Your Branch

Push the changes to your forked repository:

    git push origin feature-or-bugfix-name

7. Create a Pull Request (PR)

  1. Navigate to the original Project-N repository.
  2. Click on the Pull Requests tab and select New Pull Request.
  3. Choose your branch and submit the pull request with a clear description of your changes.

Code of Conduct

To ensure a positive environment for all contributors:

  • Be respectful and inclusive.
  • Provide constructive feedback.
  • Write clean and maintainable code.

Reporting Issues

If you find a bug, have a feature request, or need help:

  1. Check if the issue already exists in GitHub Issues.
  2. If not, create a new issue with a detailed description and steps to reproduce the problem.

Coding Guidelines

  • Use TypeScript for type safety.
  • Follow ESLint rules for consistency.
  • Write meaningful commit messages.
  • Keep pull requests small and focused.
  • Update tests and documentation where needed.

Questions & Support

For any questions or discussions, feel free to:

  • Open a GitHub issue.
  • Start a discussion in the repository.

We appreciate your contributions and look forward to working together on Project-N! 🚀