The point of this repository is to allow anyone to start contributing on a public repository.
You first need to fork the repository, then go in the directory and run:
# Install the dependencies
yarn
- Find an issue that is not assigned yet
- Implement it so that it passes all the tests (check with
yarn test src/theFunction.test.js
) - Add a test case for a new function. You can use
yarn generate
to create the two new files. - Create your Pull Request
- Create an issue for your new feature
- No libraries of any kind, just plain old vanilla js :)
- If you got assigned an issue and don't have time to do it, please say it so we can release it for someone else.
- Make sure your implementation passes the previous tests before opening a Pull Request.
- We'll de-assign you from an issue if:
- You haven't opened a PR in a few hours
- If you've opened one but not updated it in a long time
When using yarn generate
, two files are created:
theFunction.js:
export const theFunction = () => {
// TO IMPLEMENT IN ANOTHER PR
};
theFunction.test.js:
import { theFunction } from './theFunction';
describe('theFunction', () => {
it('does something', () => {
expect(true).toBeTruthy(); // TODO Your test instead
});
it('does something else', () => {
expect(true).toBeTruthy(); // TODO Your test instead
});
})
You only need to update the test file, the actual implementation will be done by someone else!