Skip to content

Latest commit

 

History

History
72 lines (46 loc) · 2.32 KB

contributing.md

File metadata and controls

72 lines (46 loc) · 2.32 KB

Contributing to GitHub Issue Finder

Thank you for considering contributing to GitHub Issue Finder! We welcome your contributions to make this project better. To contribute, please follow the guidelines below.

Getting Started

To get started, make sure you have the necessary software and tools installed:

  • Node.js (version 12 or higher)
  • npm (Node Package Manager)

Setting up the Development Environment

  1. Clone the repository:

    git clone https://github.com/bashamega/github-issue-finder.git

  2. Navigate to the project directory:

    cd github-issue-finder

  3. Install dependencies:

    npm install
4. Create a `.env` file, then add you github personal token.
5. Start the development server:
```bash
npm start

This will launch the application in your browser at http://localhost:3000.

Making Contributions

When making contributions, please keep the following guidelines in mind:

Fork the repository and create a new branch for your contribution. Make sure your code follows the existing code style and formatting conventions. Write clear and concise commit messages. Test your changes thoroughly before submitting a pull request. Document any new features or significant changes. Ensure your code does not introduce any linting errors or warnings. Submitting a Pull Request To submit your contribution, follow these steps:

Commit your changes to your forked repository.

Push your changes to your forked repository.

Visit the original repository and create a new pull request, comparing your branch with the main branch.

Provide a descriptive title and detailed description for your pull request.

Wait for the maintainers to review your contribution. Make sure to address any feedback or questions promptly.

Once approved, your changes will be merged into the main repository.

Reporting Issues

If you encounter any issues while using GitHub Issue Finder, please report them in the issue tracker. Provide a clear and detailed description of the problem, along with any relevant information to help us reproduce and investigate the issue.

Code of Conduct

Please note that GitHub Issue Finder has a code of conduct. By participating in this project, you are expected to uphold the code of conduct. Any unacceptable behavior should be reported to the project maintainers.