We'd love for you to contribute to our source code and to make Angular Meteor even better than it is today! Here are the guidelines we'd like you to follow:
- Code of Conduct
- Question or Problem?
- Issues and Bugs
- Feature Requests
- Submission Guidelines
- Contribution Setup
- Commit Message Guidelines
I love the Angular community so let's just use thier Code of Conduct.
If you are subject to or witness unacceptable behavior, or have any other concerns, please email me at uri.goldshtein@gmail.com.
If you have questions about how to use Angular Meteor, please direct these to StackOverflow or the Meteor forums.
If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Repository. Even better you can submit a Pull Request with a fix.
We manage the project roadmap in Github issues and milestones. There is a public Waffle board
dedicated to angular-meteor. You can add an issue about what you want to see in the library or in the tutorial.
Our goal with the tutorial is to add as many common use cases as possible. If you want to create and add your own chapter we would be happy to help you writing and adding it.
Also if you want to record a video for a chapter we would love to help you.
- Make videos as short as possible - easier to update and nicer to watch - be short as a sub-step (2.5, 3.11, etc...)
- Upload your video to Youtube and send us the link - add tags and miningful content descriptions on Youtube
- Upload your video sources to our open Github repo - That way they are editable in any way we want (translated, dubbed, improve audio, update inner parts, etc...)
- Feel free to contact me for any questions
- Just do it! we need many of those and it's really helping the tutorial. and you are doing it already anyway....
If you want to contribute and need help or don't know what should you do, you can contact me directly
Fork angular-meteor and clone the angular-meteor library to another directory named angular
mkdir angular
git clone https://github.com/[your_username]/angular-meteor.git angular
This project follows the angular project git commit message format.
Please refer to the official documentation.
You can commit changes in interactive mode by running:
npm run commit
It is a step by step process.
meteor create myProjectInstall angular-meteor for your application.
npm install angular-meteor --saveCreate a globally-installed symbolic link to your forked repository.
cd /path_to_your_repos/angular-meteor/
npm linkNow create a symlink from the local node_modules folder to the global symlink
cd myProject
npm link angular-meteorYou can compile angular-meteor by running:
npm run buildIf you don’t want to manually recompile after every change you can use watch mode.
npm run watchmeteor create myProjectCreate a packages directory under your project's root folder and link your forked repo
cd myProject
ln -s ~/path_to_your_repos/angular-meteor/packages/The angular-meteor-data package uses the main file of angular-meteor node module.
To start using a local file you should run:
npm run dev:startTo compile new file for angular-meteor-data package you can run:
npm run build:devIf you don’t want to manually recompile after every change you can use watch mode.
npm run watch:devBoth above commands run npm run dev:start automaticaly, so you don't have to trigger it by yourself.
Now you can start using your own copy of the angular-meteor project from myProject.
You should remember one thing.
Since angular-meteor-data package uses main file of angular-meteor npm package and you've already changed it using above commands, you should somehow restore that state. It's easy, just use this command:
npm run dev:stopIn the command line
npm run test:watch
Then go to localhost:3000 in your browser
Whether it's a typo, some clarification, or a whole new feature - here's how to get started:
- Clone angular-meteor on your local machine
- Clone the docs repository at
https://github.com/urigo/angular-meteor-docs - Run the app for the documentation
meteor - Start tweaking and updating!