Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Welcome to the Agenda! Lightweight job scheduling for node.
Meet the team.
How we work
- Work via pull requests. If you're a maintainer, create a new branch under repository or in your fork.
Keep your PRs focused; if you want to change multiple things, do multiple PRs. This helps us to focus discussion on single topics, makes reviewing easier and probably even helps to get smaller changes faster into
- Simple changes to markdown or other meta files can be pushed directly to master, but anything that touches functionality should always go via PR. This includes code, tests, build tools, Travis and linting configs.
- Give time for discussion, don't merge in a hurry. Wait for at least one "LGTM" from other maintainer, preferably from two if it's a major change. It's better wait for two days to see if someone has comments rather than merge something that might cause a breaking change.
- Add tests. Don't merge changes or new features without tests added.
- Keep commit messages clear. Users and other developers rely on our commit messages to be clear and concise.
- Update the Documentation to go along with any changes in functionality
Generating a new Release
For those who will be generating releases:
Update the changelog and clearly indicate effects of update to users, especially breaking changes.
Use np - Don't be afraid to pump up major version if you merged in a breaking change.
npwill take care of the process so please don't change any of the version numbers in any files or create any git tags manually.
npinstall it via
yarn global add npor
npm install -g np. Then just run
npand follow the prompts.
Code of Conduct
Ubuntu Code of Conducts is a great read if you're new to open source community.
Your actions and work will affect and be used by other people and you in turn will depend on the work and actions of others. Any decision you take will affect other community members, and we expect you to take those consequences into account when making decisions.
Disagreement is no excuse for poor manners. Assume good intentions and do our best to act in an empathic fashion. We don't allow frustration to turn into a personal attack. In a disagreement, in the first instance assume that people mean well.
We can all make mistakes; when we do, we take responsibility for them. It's ok to do mistakes, just work together to right the wrong and be supportive.
We value tangible results over having the last word in a discussion. Don't let arguments about minor issues get in the way of achieving more important results. Let decisions be taken by those who do the work.