Skip to content

Latest commit

 

History

History
104 lines (67 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

104 lines (67 loc) · 2.48 KB
Raw

Contributing to FinTracker Frontend

We welcome contributions from everyone!

How to Contribute

1. Fork the Repository

  • Click the "Fork" button at the top right of the repository page. This will create your own copy of the project where you can freely make changes.

2. Clone Your Fork

  • Clone your forked repository to your local machine:
git clone https://github.com/<your-username>/fin-tracker-frontend.git
  • Replace <your-username> with your GitHub username.
  • Navigate into the project directory:
cd fin-tracker-frontend

3. Set Up Your Development Environment

  • Install Dependencies:
npm install
  • Make sure you have Node.js and npm installed.
  • Start the Development Server:
ng serve
  • This will start the Angular development server, typically at http://localhost:4200/.

4. Create a New Branch

  • Always work on a new branch for each feature or bug fix:
git checkout -b feature/your-feature-name

or

git checkout -b bugfix/your-bug-fix-name

5. Make Your Changes

  • Follow the project's code style and conventions.
  • Write clear, concise commit messages.

6. Test Thoroughly

  • Run the development server (ng serve) to test your changes in the browser.

7. Commit and Push

  • Commit your changes with a clear, descriptive message:
git commit -m "Add your descriptive commit message here"
  • Push your branch to your forked repository:
git push origin feature/your-feature-name

8. Create a Pull Request (PR)

  • On GitHub, go to the original repository's page.
  • Click "New pull request" or "Compare & pull request" (if it's visible).
  • Select your branch as the "head" branch and the main repository's main (or develop) branch as the "base" branch.
  • Provide a clear title and description explaining your changes.
  • Reference any related issues (if applicable).
  • Click "Create pull request".

9. Review and Collaboration

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

Additional Notes

  • Communication: Feel free to ask questions or discuss your ideas in our Discord server.

Alternative Contribution Methods (Beyond Code):

  • Reporting bugs and issues.
  • Improving documentation.
  • Providing user feedback and suggestions.
  • Participating in discussions and forums.
  • Spreading the word about FinTracker!

We appreciate your contributions and are excited to have you join our community!