Skip to content

Latest commit

 

History

History
51 lines (28 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

51 lines (28 loc) · 1.86 KB

Contributing to Nexus

Welcome to Nexus! We're thrilled that you're considering contributing to our project. Before you get started, please take a moment to read this document to understand the contribution process.

Hacktoberfest

Nexus is participating in Hacktoberfest. To qualify for a Hacktoberfest tree, you need to make at least four meaningful pull requests to this repository.

Getting Started

  1. Fork the repository: Click the "Fork" button at the top right of this repository.

  2. Clone your fork: Clone your fork of the repository to your local machine.

    git clone https://github.com/mlscgescoe/nexus.git

  3. Create a New Branch: Create new branch for the changes you make in the project

    git checkout -b feature/your-feature

  4. Make your Changes: Solve the issues in the project by modifying codebase

  5. Commit your Changes: Commit the changes to your newly created branch

    git commit -m "Your meaningful commit message"

  6. Push Changes: Push the changes to the repository forked on you GitHub account

    git push origin feature/your-feature

  7. Create a Pull Request: After code is pushed to the Repository on your Account, Create a Pull Request

Contributing Guidlines

  • Please make sure your pull request is concise and to the point. If you're adding a new feature or fixing a bug, explain the problem and the solution.

  • Keep pull requests small and focused. If you have multiple contributions, create a separate pull request for each.

  • Write clear and detailed commit messages.

  • Make sure your code is well-documented. Include comments as necessary.

  • All contributions should pass the existing tests and linters.

  • Ensure your code follows the existing coding style of the project.

  • Be open to feedback and willing to make necessary changes.