Skip to content

Latest commit

 

History

History
105 lines (62 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

105 lines (62 loc) · 2.94 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our open-source social media web app! We welcome contributions from developers like you. By following these guidelines, you can help us maintain a collaborative and inclusive environment for all contributors.

Table of Contents

  1. Getting Started
  2. Contributing Process
  3. Code of Conduct
  4. License

Getting Started

Prerequisites

Make sure you have the following dependencies installed:

  • Node.js (version X.X.X)
  • [Database System] (e.g., MySQL, PostgreSQL, MongoDB)

Installation

  1. Clone the repository:
   git clone https://github.com/itsOdell/rupture.git
   cd rupture
  1. Install the project dependencies:
   cd rupture
   npm install
  1. Configure the database connection:
  • Copy the .env.example file to .env and update the necessary configurations.
  1. Build and run the project:
   npm run start

The application should now be running at http://localhost:3001.

Contributing Process

Issue Tracker

Before starting any work, please check the issue tracker on our GitHub repository to find any existing issues or feature requests. If you don't find a related issue, feel free to open a new one and discuss it with the community.

Branching

  1. Create a new branch for your contribution:
   git checkout -b feature/your-feature

For bug fixes, use bugfix/your-fix as the branch name.

  1. Ensure that your branch name is descriptive and explains the purpose of your changes.

Commit Guidelines

  1. Make your commits atomic and focused on a single task.
  2. Write clear and concise commit messages that explain the purpose of your changes.
  3. Reference the relevant issue number in your commit message using the format #issue-number.

Code Style

Follow the existing code style and conventions used in the project. Ensure that your changes adhere to the project's linting rules.

Testing

Write tests for the code you contribute. Run the test suite before submitting your pull request to ensure that your changes pass all the tests.

Code of Conduct

Please review and abide by our Code of Conduct to create a welcoming and inclusive community for everyone.

License

By contributing to this project, you agree that your contributions will be licensed under the LICENSE file of this repository.

Thank you for your interest and we appreciate your contributions to our social media web app! If you have any questions, feel free to reach out to the project maintainers or join our community chat.

Happy coding!